You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+51-27Lines changed: 51 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,12 +2,11 @@
2
2

3
3
4
4
## CastleCSS Framework
5
-
The core files are part of the [Full CastleCSS Package](https://github.com/CastleCSS/castlecss)
6
-
5
+
The core files are part of the [CastleCSS Package](https://github.com/CastleCSS/castlecss)
7
6
8
7
## How to install
9
-
- Install via [NPM](https://www.npmjs.com/): ```npm install castlecss-core```
10
-
- Require it in your own NPMJS package
8
+
- Install via [npm](https://www.npmjs.com/): ```npm install castlecss-core```
9
+
- Require it in your own npm package
11
10
- Download or clone the package
12
11
13
12
## Updating files
@@ -16,39 +15,64 @@ CastleCSS is built so it's easy to update, you can just download make it your ow
16
15
```npm update castlecss-core```
17
16
18
17
## Documentation and examples
19
-
You can find the documentation and examples at http://www.castlecss.com and [castlecss-docs](https://github.com/CastleCSS/castlecss-buttons)
18
+
You can find the documentation and examples at http://www.castlecss.com and [castlecss-docs](https://github.com/CastleCSS/castlecss-docs)
19
+
20
+
21
+
## Adjusting the variables
22
+
Because of the unique update-able setup of CastleCSS you need a seperate variable file to overwrite the default CastleCSS variables. There are a few ways to do this:
23
+
24
+
- Use the [boilerplate](https://github.com/CastleCSS/castlecss-boilerplate/) which provides a variables.scss file
25
+
- Copy variables.scss from /node_modules/castlecss-core/sass/variables.scss into your own scss folder and include it into your main.scss
26
+
- Copy the example from the [documentation](http://castlecss.com/variables.html) into your own variables.scss and include it into your main.scss
20
27
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.
28
+
## Basic structure
29
+
The basis structure for your website should look similar like this:
24
30
25
31
```
26
-
| Your project/
32
+
| Project directory/
27
33
|
28
-
|-- scss/
29
-
| |-- /* Custom project specific scss files here */
30
-
| |-- Main.scss
31
-
| |
32
34
|-- node_modules/
33
-
| |
34
-
| | /* CastleCSS files included automatically here */
35
-
| | castlecss-core/
36
-
| | castlecss-buttons/
37
-
| | castlecss-etc ;)/
35
+
| | -- castlecss-core/
36
+
| | --castlecss-buttons/
37
+
| | --castlecss-notifications/
38
+
| |
39
+
|-- scss/
40
+
| |-- main.scss
41
+
| |-- variables.scss
42
+
| |
43
+
|-- img/
44
+
|-- dist/
45
+
| |-- styles.min.css
46
+
| |-- styles.min.map
47
+
| |
48
+
|-- index.html
49
+
|-- Gruntfile.js
50
+
|-- package.json
38
51
```
39
52
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)):
0 commit comments