Skip to content

Commit e284ba6

Browse files
author
DNZ\darius
committed
Merge branch 'hotfix/Version_bump_to_2.1.0' into develop
2 parents c490a83 + 39badbf commit e284ba6

File tree

3 files changed

+53
-29
lines changed

3 files changed

+53
-29
lines changed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2016 CastleCSS
3+
Copyright (c) 2016 De Nieuwe Zaak
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 51 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,11 @@
22
![CastleCSS logo @CastleCss.com](https://www.doordarius.nl/castlecss-logo-250.png)
33

44
## 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)
76

87
## 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
1110
- Download or clone the package
1211

1312
## Updating files
@@ -16,39 +15,64 @@ CastleCSS is built so it's easy to update, you can just download make it your ow
1615
```npm update castlecss-core```
1716

1817
## 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
2027

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:
2430

2531
```
26-
| Your project/
32+
| Project directory/
2733
|
28-
|-- scss/
29-
| |-- /* Custom project specific scss files here */
30-
| |-- Main.scss
31-
| |
3234
|-- 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
3851
```
3952

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)):
53+
### main.scss
54+
Your main.scss should have the following set-up:
4255

4356
```
44-
/* core variable files */
57+
/* CastleCSS Core variables */
4558
@import "node_modules/castlecss-core/sass/variables";
46-
/* Your own variables so they overwrite the core */
59+
60+
/* Your variables */
4761
@import "variables";
48-
/* rest of core files */
62+
63+
/* Remaining Core files and other CastleCSS modules */
4964
@import "node_modules/castlecss-core/sass/main";
50-
51-
/* Include your own files below this line
52-
--------------------------------------
53-
*/
65+
@import "node_modules/castlecss-buttons/sass/main";
66+
@import "node_modules/castlecss-notifications/sass/main";
67+
68+
/* Include your own files below this line
69+
-------------------------------------- */
70+
71+
72+
73+
/* --------------------------------------
74+
Include your own files above this line */
75+
76+
@import "node_modules/castlecss-core/sass/base/utility";
77+
@import "node_modules/castlecss-core/sass/base/utility_spacers";
5478
```

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "castlecss-core",
3-
"version": "2.0.1",
3+
"version": "2.1.0",
44
"description": "CastleCSS a SCSS framework with modular building blocks for the web",
55
"main": "index.js",
66
"scripts": {

0 commit comments

Comments
 (0)