Skip to content
This repository was archived by the owner on Mar 17, 2026. It is now read-only.

Commit e15219f

Browse files
author
Darius Rosendahl
committed
Merge branch 'hotfix/Readme'
2 parents 2b3ee74 + 4bca535 commit e15219f

1 file changed

Lines changed: 11 additions & 8 deletions

File tree

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# 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.
33

44
![CastleCSS logo @CastleCss.com](https://www.doordarius.nl/castlecss-logo-250.png)
55

@@ -9,19 +9,22 @@ This is a meta package with all available packages for CastleCSS:
99
- [castlecss-core](https://github.com/CastleCSS/castlecss-core)
1010
- [castlecss-buttons](https://github.com/CastleCSS/castlecss-buttons)
1111
- [castlecss-notifications](https://github.com/CastleCSS/castlecss-notifications)
12+
- [castlecss-icons](https://github.c
13+
om/CastleCSS/castlecss-icons)
1214

1315
## Getting Started
1416
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.
1517

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```
1720
- Clone the package ```git clone https://github.com/CastleCSS/castlecss.git```
1821

1922
Make sure to run ```npm install``` from your directory to install the dependencies and start using CastleCSS.
2023

2124
### Adjusting the variables
2225
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:
2326

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
2528
- Copy variables.scss from /node_modules/castlecss-core/sass/variables.scss into your own scss folder and include it into your main.scss
2629
- Copy the example from the [documentation](http://castlecss.com/variables.html) into your own variables.scss and include it into your main.scss
2730

@@ -33,9 +36,7 @@ This front-end framework is easy updatable. This has the advantage that new feat
3336

3437
We recommend updating the dependencies as follows:
3538
```
36-
npm update castlecss-core
37-
npm update castlecss-buttons
38-
npm update castlecss-notifications
39+
npm update
3940
```
4041

4142
## Documentation and examples
@@ -51,6 +52,7 @@ Your project should have a setup similar to this:
5152
| | -- castlecss-core/
5253
| | -- castlecss-buttons/
5354
| | -- castlecss-notifications/
55+
| | -- castlecss-icons/
5456
| |
5557
|-- scss/
5658
| |-- main.scss
@@ -62,7 +64,7 @@ Your project should have a setup similar to this:
6264
| |-- styles.min.map
6365
| |
6466
|-- index.html
65-
|-- Gruntfile.js
67+
|-- Gruntfile.js (or gulp, or whatever you want to use)
6668
|-- package.json
6769
```
6870

@@ -82,6 +84,7 @@ Your main.scss should have the following setup:
8284
@import "path/to/castlecss-core/sass/main";
8385
@import "path/to/castlecss-buttons/sass/main";
8486
@import "path/to/castlecss-notifications/sass/main";
87+
@import "path/to/castlecss-icons/sass/main";
8588
8689
/* Include your own files below this line
8790
-------------------------------------- */
@@ -102,4 +105,4 @@ We're currently working hard on making the CastleCSS expansions and improvements
102105
Please see the [ROADMAP.MD](https://github.com/CastleCSS/castlecss/blob/master/ROADMAP.md) for our current plans for the future.
103106

104107
## Contributing
105-
Want to contribute? We'd love your help, please take a look at the roadmap or submit new suggestions.
108+
Want to contribute? We'd love your help, please take a look at the roadmap or submit new suggestions.

0 commit comments

Comments
 (0)