Skip to content

Commit a4733ab

Browse files
Update README.md
1 parent 72fa135 commit a4733ab

File tree

1 file changed

+40
-22
lines changed

1 file changed

+40
-22
lines changed

README.md

Lines changed: 40 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -18,37 +18,55 @@ CastleCSS is built so it's easy to update, you can just download make it your ow
1818
## Documentation and examples
1919
You can find the documentation and examples at http://www.castlecss.com and [castlecss-docs](https://github.com/CastleCSS/castlecss-buttons)
2020

21-
## Setup
22-
Your project should have a setup similair to this (included in the [Full CastleCSS Package](https://github.com/CastleCSS/castlecss)):
23-
With this you make sure your own variables overwrite the castle-core variables and your setup is still updatable.
21+
22+
## Basic structure
23+
The basis structure for your website should look similar like this:
2424

2525
```
26-
| Your project/
26+
| Project directory/
2727
|
28-
|-- scss/
29-
| |-- /* Custom project specific scss files here */
30-
| |-- Main.scss
31-
| |
3228
|-- node_modules/
33-
| |
34-
| | /* CastleCSS files included automatically here */
35-
| | castlecss-core/
36-
| | castlecss-buttons/
37-
| | castlecss-etc ;)/
29+
| | -- castlecss-core/
30+
| | --castlecss-buttons/
31+
| | --castlecss-notifications/
32+
| |
33+
|-- scss/
34+
| |-- main.scss
35+
| |-- variables.scss
36+
| |
37+
|-- img/
38+
|-- dist/
39+
| |-- styles.min.css
40+
| |-- styles.min.map
41+
| |
42+
|-- index.html
43+
|-- Gruntfile.js
44+
|-- package.json
3845
```
3946

40-
### Main.scss
41-
Your main.scss should have a setup similair to this (included in the [Full CastleCSS Package](https://github.com/CastleCSS/castlecss)):
47+
### main.scss
48+
Your main.scss should have the following set-up:
4249

4350
```
44-
/* core variable files */
51+
/* CastleCSS Core variables */
4552
@import "node_modules/castlecss-core/sass/variables";
46-
/* Your own variables so they overwrite the core */
53+
54+
/* Your variables */
4755
@import "variables";
48-
/* rest of core files */
56+
57+
/* Remaining Core files and other CastleCSS modules */
4958
@import "node_modules/castlecss-core/sass/main";
50-
51-
/* Include your own files below this line
52-
--------------------------------------
53-
*/
59+
@import "node_modules/castlecss-buttons/sass/main";
60+
@import "node_modules/castlecss-notifications/sass/main";
61+
62+
/* Include your own files below this line
63+
-------------------------------------- */
64+
65+
66+
67+
/* --------------------------------------
68+
Include your own files above this line */
69+
70+
@import "node_modules/castlecss-core/sass/base/utility";
71+
@import "node_modules/castlecss-core/sass/base/utility_spacers";
5472
```

0 commit comments

Comments
 (0)