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
{{ message }}
This repository was archived by the owner on Mar 17, 2026. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+11-8Lines changed: 11 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
# CastleCSS
2
-
CastleCSS is a modular, updatable, easy-to-use HTML5 and SCSS framework. It includes a flexible grid system, buttons, notifications, utility classes and a set of Sass mixins to make a quick start for your site or app.
2
+
CastleCSS is a modular, updatable, easy-to-use HTML5 and SCSS framework. It includes a flexible grid system, buttons, notifications, utility classes, icons and a set of Sass mixins to make a quick start for your site or app.
3
3
4
4

5
5
@@ -9,19 +9,22 @@ This is a meta package with all available packages for CastleCSS:
There are a few ways to get started with CastleCSS. If you're setting things up all by yourself, the easiest way to install is through the npm package manager or to clone the package in your project directory.
15
17
16
-
- Install with [npm](https://www.npmjs.com/): ```npm install castlecss```
18
+
- Download the [CastleCSS Boilerplate](https://www.github.com/CastleCSS/castlecss-boilerplate). All Packages are included + examples and project setup
19
+
- Install with [npm](https://www.npmjs.com/): ```npm install castlecss -S```
17
20
- Clone the package ```git clone https://github.com/CastleCSS/castlecss.git```
18
21
19
22
Make sure to run ```npm install``` from your directory to install the dependencies and start using CastleCSS.
20
23
21
24
### Adjusting the variables
22
25
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
26
24
-
-Use the [boilerplate](https://github.com/CastleCSS/castlecss-boilerplate/) which provides a variables.scss file
27
+
-Download the [CastleCSS Boilerplate](https://www.github.com/CastleCSS/castlecss-boilerplate). All Packages are included + examples and project setup
25
28
- Copy variables.scss from /node_modules/castlecss-core/sass/variables.scss into your own scss folder and include it into your main.scss
26
29
- Copy the example from the [documentation](http://castlecss.com/variables.html) into your own variables.scss and include it into your main.scss
27
30
@@ -33,9 +36,7 @@ This front-end framework is easy updatable. This has the advantage that new feat
33
36
34
37
We recommend updating the dependencies as follows:
35
38
```
36
-
npm update castlecss-core
37
-
npm update castlecss-buttons
38
-
npm update castlecss-notifications
39
+
npm update
39
40
```
40
41
41
42
## Documentation and examples
@@ -51,6 +52,7 @@ Your project should have a setup similar to this:
51
52
| | -- castlecss-core/
52
53
| | -- castlecss-buttons/
53
54
| | -- castlecss-notifications/
55
+
| | -- castlecss-icons/
54
56
| |
55
57
|-- scss/
56
58
| |-- main.scss
@@ -62,7 +64,7 @@ Your project should have a setup similar to this:
62
64
| |-- styles.min.map
63
65
| |
64
66
|-- index.html
65
-
|-- Gruntfile.js
67
+
|-- Gruntfile.js (or gulp, or whatever you want to use)
66
68
|-- package.json
67
69
```
68
70
@@ -82,6 +84,7 @@ Your main.scss should have the following setup:
0 commit comments