Skip to content

Commit 707e4ec

Browse files
Update README.md
1 parent fb77182 commit 707e4ec

File tree

1 file changed

+18
-25
lines changed

1 file changed

+18
-25
lines changed

README.md

Lines changed: 18 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -15,34 +15,27 @@ CastleCSS is built so it's easy to update, you can just download make it your ow
1515

1616
```npm update castlecss-core```
1717

18+
## Documentation
19+
We're currently writing the documentation. Hang on tight!
20+
1821
## Setup
19-
Your project should have a setup similair to this (included in the [Full CastleCSS Package](https://github.com/CastleCSS/castlecss).):
22+
Your project should have a setup similair to this (included in the [Full CastleCSS Package](https://github.com/CastleCSS/castlecss)):
2023
With this you make sure your own variables overwrite the castle-core variables and your setup is still updatable.
2124

22-
23-
| Your project/
24-
|-- sass/
25-
| |-- Custom project specific files here
26-
| |-- Main.scss //include castlecss main.scss files here first, your project specific files after that
27-
| |
28-
| |-- node_modules/ //CastleCSS files are automatically installed here
29-
| | |
30-
| | | castlecss-core/
31-
| | | |
32-
| | | |-- sass/
33-
| | | | |-- main.scss - include all your other SCSS files
34-
| | | |
35-
| | | |-- base/
36-
| | | | |-- reset.scss - set browser defaults to zero/none so nothing weird happends in different browsers
37-
| | | | |-- variables.scss - Variables for the grid, fonts, utility, etc
38-
| | | | |-- defaults.scss - Set default web settings
39-
| | | | |-- mixins.scss - Small but handy collection of mixins to use
40-
| | | | |-- utility.scss - Utility classes
41-
| | | | |-- utility_spacers.scss - Utility padding / margin classes
42-
| | | |
43-
| | | |-- layout/
44-
| | | | |-- grid.scss - *Flexbox scss grid with floating fallback*
45-
| | | | |-- static_files.scss - *Static files like containers*
25+
```
26+
| Your project/
27+
|
28+
|-- scss/
29+
| |-- /* Custom project specific scss files here */
30+
| |-- Main.scss
31+
| |
32+
|-- node_modules/
33+
| |
34+
| | /* CastleCSS files included automatically here */
35+
| | castlecss-core/
36+
| | castlecss-buttons/
37+
| | castlecss-etc ;)/
38+
```
4639

4740
### Main.scss
4841
Your main.scss should have a setup similair to this (included in the [Full CastleCSS Package](https://github.com/CastleCSS/castlecss)):

0 commit comments

Comments
 (0)