Skip to content

Commit 0a5a7b5

Browse files
Merge remote-tracking branch 'origin/master'
# Conflicts: # README.md
2 parents cda983b + 905b717 commit 0a5a7b5

File tree

1 file changed

+52
-27
lines changed

1 file changed

+52
-27
lines changed

README.md

Lines changed: 52 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -12,48 +12,73 @@ Our philosophy is mobile first, self explanatory code code and breakpoints. On t
1212
### Breakpoint CSS
1313
We don't believe in classes like *laptop* or *small* and other classes but we define everything with **b{breakpoint}** this makes everything readable and since we use this throughout the whole framework everything feels familiar when you use it for a while. Whether it's for grid, utility classes, hiding, showing. It all starts with **b{breakpoint}**
1414

15-
## Included files
15+
### Breakpoints
16+
Mobile first breakpoints (defined in variables.scss)
17+
18+
b0: 0px; (smartwatch and higher)
19+
b1: 320px; (phone portait and higher)
20+
b2: 480px; (phone landscape and higher)
21+
b3: 768px; (tablet portait and higher)
22+
b4: 1024px; (tablet landscape/desktop and higher)
23+
b5: 1280px; (desktop large and higher)
24+
b6: 1600px; (desktop huge and higher)
25+
26+
As your base you can always just use b0, only use b1 if you have a totally different markup <320px
27+
28+
## Included files and structure
1629
CastleCSS Core has the following basic files to kickstart your website:
1730

18-
- main - *include all your other SCSS files*
19-
- reset - *set browser defaults to zero/none so nothing weird happends in different browsers*
20-
- variables - *Variables for the grid, fonts, utility, etc*
21-
- grid - *Flexbox scss grid with floating fallback*
22-
- defaults - *Set default web settings*
23-
- mixins - *Small but handy collection of mixins to use*
24-
- utility - *Utility classes*
25-
- utility_spacers - *Utility padding / margin classes*
31+
### SCSS folder structure and overwriting the CastleCSS defaults
32+
The ideal structure of your SASS folder should be the following:
33+
34+
| Your project/
35+
|-- sass/
36+
| |-- Custom project specific files here
37+
| |-- Main.scss //include castlecss main.scss files here first, your project specific files after that
38+
| |
39+
| |-- node_modules/ //CastleCSS files are automatically installed here
40+
| | |
41+
| | | castlecss-core/
42+
| | | |
43+
| | | |-- sass/
44+
| | | | |-- main.scss - include all your other SCSS files
45+
| | | |
46+
| | | |-- base/
47+
| | | | |-- reset.scss - set browser defaults to zero/none so nothing weird happends in different browsers
48+
| | | | |-- variables.scss - Variables for the grid, fonts, utility, etc
49+
| | | | |-- defaults.scss - Set default web settings
50+
| | | | |-- mixins.scss - Small but handy collection of mixins to use
51+
| | | | |-- utility.scss - Utility classes
52+
| | | | |-- utility_spacers.scss - Utility padding / margin classes
53+
| | | |
54+
| | | |-- layout/
55+
| | | | |-- grid.scss - *Flexbox scss grid with floating fallback*
56+
| | | | |-- static_files.scss - *Static files like containers*
57+
58+
### Overwrite CastleCSS
59+
Of course you want to be able to set your own variables and other classes. To do this: make your own custom folder outside of node modules folder and include the files in your main.scss.
2660

2761
## How to install
28-
You can install castle css with NPM in your sass folder:
62+
You can install castle css with [NPM](https://nodejs.org) in your sass folder:
2963

30-
npm i castlecss-core
31-
64+
npm i castlecss-core
65+
3266
### How to update
3367
Type the following to check for updates in your sass folder:
34-
35-
npm outdated
36-
68+
69+
npm outdated
70+
3771

3872
Nothing? Good! Then you're up to date
3973
In any other case you'll get something that looks like this:
4074

41-
Package Current Wanted Latest Location
42-
castlecss-core 1.0.0 1.1.0 1.1.0 castlecss-core
75+
Package Current Wanted Latest Location
76+
castlecss-core 1.0.0 1.1.0 1.1.0 castlecss-core
4377

4478
So type the following to update:
4579

46-
npm update
80+
npm update
4781

4882
If you didn't alter the core files it will now update.
4983
If the updated did succeed you shouldn't get anything back from your terminal if you use *npm outdated* again
5084

51-
# SCSS folder structure and overwriting the CastleCSS defaults
52-
Of course you want to be able to set your own variables and other classes. To do this: make your own custom folder outside of node modules and include the files. The ideal structure of your SASS folder should be the following:
53-
54-
| Your project
55-
| -- sass/ //your custom scss goes here
56-
| -- | main.scss //include your own SCSS files and /node_modules/castlecss-core/main.scss here
57-
| -- | node_modules/ //CastleCSS files are automatically installed here
58-
| -- | -- castlecss-core/
59-
| -- | -- | sass

0 commit comments

Comments
 (0)