Skip to content

Commit 794ebe0

Browse files
committed
Rewrote README.md with the appropriate explanation for using the CastleCSS Boilerplate.
1 parent a1cf6ce commit 794ebe0

File tree

1 file changed

+47
-55
lines changed

1 file changed

+47
-55
lines changed

README.md

Lines changed: 47 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,80 +1,72 @@
1-
# CastleCSS (Full package)
2-
A modular, updatable, easy to use HTML and SCSS framework.
1+
# CastleCSS Boilerplate
2+
[CastleCSS](https://github.com/CastleCSS/) is a modular, updatable and easy to use HTML and SCSS framework.
3+
Use this Boilerplate to get started with your project right away!
34

45
![CastleCSS logo @CastleCss.com](https://www.doordarius.nl/castlecss-logo-250.png)
56

67
## What's included?
7-
Included in this package:
8-
- Example project setup
9-
- Gruntfile.js and tasks
8+
- A simple and mobile-friendly HTML5 template to kickstart your website
9+
- Configuration for Grunt, to easily compile and minify your Sass files
1010
- [castlecss-core](https://github.com/CastleCSS/castlecss-core)
1111
- [castlecss-buttons](https://github.com/CastleCSS/castlecss-buttons)
1212
- [castlecss-notifications](https://github.com/CastleCSS/castlecss-notifications)
13-
- [castlecss-docs (documentation)](https://github.com/CastleCSS/castlecss-docs)
1413

15-
## How to install
16-
CastleCSS is built with easy updating in mind.
17-
You can download the full package and make adjustments as long as you don't update the dependencies (core, buttons, notifications and docs). When you decide to adjust the dependencies, you will lose them with the next update.
14+
## Get started
15+
1. Clone ```git clone https://github.com/CastleCSS/castlecss.git``` or [download](https://github.com/CastleCSS/castlecss-boilerplate/archive/master.zip) CastleCSS Boilerplate.
16+
2. Set up your project directory and a basic site structure.
17+
3. Run Grunt from your directory by typing ```Grunt``` in the commandline. If you haven't used Grunt before, be sure to check out the Getting Started guide.
18+
4. Add some content, do some styling and include functionality.
19+
5. Run your site locally and see how it all works out!
1820

19-
There are a few ways to install:
20-
21-
- [Download the latest release](https://github.com/CastleCSS/castlecss/archive/master.zip)
22-
- Clone the package ```git clone https://github.com/CastleCSS/castlecss.git```
23-
- Install via [npm](https://www.npmjs.com/): ```npm install castlecss```
24-
- Add it to your package.json in your own npm package
25-
26-
When downloading or cloning CastleCSS, you have to run ```npm install``` from the directory to get the full package (core, buttons, notifications and docs).
27-
28-
## Updating files
29-
30-
NOTE: Only update the dependencies so that you don't overwrite your own SCSS files. If you do update the full package you'll overwrite everything.
31-
32-
We recommend downloading the full package and updating the dependencies like:
33-
```
34-
npm update castlecss-core
35-
npm update castlecss-buttons
36-
npm update castlecss-notifications
37-
npm update castlecss-docs
38-
```
39-
40-
## Documentation and examples
41-
You can find the documentation and examples at http://www.castlecss.com and included in this package (castlecss-docs)
42-
43-
## Setup
44-
Your project should have a setup similair to this (included in the Full package):
45-
With this you make sure your own variables overwrite the castle-core variables and your setup is still updatable.
21+
## Basic structure
22+
The basis structure for your website should look similar like this:
4623

4724
```
48-
| Your project/
25+
| Project directory/
4926
|
27+
|-- node_modules/
28+
| | -- castlecss-core/
29+
| | --castlecss-buttons/
30+
| | --castlecss-notifications/
31+
| |
5032
|-- scss/
51-
| |-- /* Custom project specific scss files here */
5233
| |-- main.scss
34+
| |-- variables.scss
5335
| |
54-
|-- node_modules/
36+
|-- img/
37+
|-- dist/
38+
| |-- styles.min.css
39+
| |-- styles.min.map
5540
| |
56-
| | /* CastleCSS files included automatically here */
57-
| | castlecss-core/
58-
| | castlecss-buttons/
59-
| | castlecss-etc ;)/
41+
|-- index.html
42+
|-- Gruntfile.js
43+
|-- package.json
6044
```
6145

6246
### main.scss
63-
Your main.scss should have a setup similar to this (included in the [CastleCSS (Full package)](https://github.com/CastleCSS/castlecss)):
47+
Your main.scss should have the following set-up:
6448

6549
```
66-
/* castlecss variable files */
67-
@import "path/to/castlecss-core/sass/variables";
50+
/* Core variables */
51+
@import "node_modules/castlecss-core/sass/variables";
6852
69-
70-
/* Your own variables so they overwrite the core */
53+
/* Your variables */
7154
@import "variables";
72-
/* rest of castle files */
73-
@import "path/to/castlecss-core/sass/main";
74-
@import "path/to/castlecss-buttons/sass/variables";
75-
@import "path/to/castlecss-notifications/sass/variables";
7655
77-
/* Include your own files below this line
78-
--------------------------------------
79-
*/
56+
/* Remaining core files */
57+
@import "node_modules/castlecss-core/sass/main";
58+
@import "node_modules/castlecss-buttons/sass/main";
59+
@import "node_modules/castlecss-notifications/sass/main";
60+
61+
/* Include your own files below this line
62+
-------------------------------------- */
63+
64+
/* --------------------------------------
65+
Include your own files above this line */
66+
67+
@import "node_modules/castlecss-core/sass/base/utility";
68+
@import "node_modules/castlecss-core/sass/base/utility_spacers";
8069
```
70+
71+
## Documentation and examples
72+
Check out http://www.castlecss.com for an extended documentation and more examples!

0 commit comments

Comments
 (0)