Skip to content

Commit c4d57cb

Browse files
2 parents cc21982 + 240bbb0 commit c4d57cb

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

README.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# CastleCSS Buttons Files
2+
![CastleCSS logo @CastleCss.com](https://www.doordarius.nl/castlecss-logo-250.png)
3+
4+
## CastleCSS Framework
5+
The buttons files are part of the [Full CastleCSS Package](https://github.com/CastleCSS/castlecss), you need this, the [castlecss-core](https://github.com/CastleCSS/castlecss) or create your own variables files in order to make castlecss-buttons work.
6+
7+
8+
## How to install
9+
- Install via [NPM](https://www.npmjs.com/): ```npm install castlecss-buttons```
10+
- Require it in your own NPMJS package
11+
- Download or clone the package
12+
13+
## Updating files
14+
CastleCSS is built so it's easy to update, you can just download make it your own as long as you don't ovewrite the core files.
15+
16+
```npm update castlecss-buttons```
17+
18+
## Documentation
19+
We're currently writing the documentation. Hang on tight!
20+
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.
24+
25+
```
26+
| Your project/
27+
|
28+
|-- scss/
29+
| |-- /* Custom project specific scss files here */
30+
| |-- Main.scss
31+
| |
32+
|-- node_modules/
33+
| |
34+
| | /* CastleCSS files included automatically here */
35+
| | castlecss-core/
36+
| | castlecss-buttons/
37+
| | castlecss-etc ;)/
38+
```
39+
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)):
42+
43+
```
44+
/* core variable files */
45+
@import "path/to/castlecss-core/sass/variables";
46+
47+
/* Your own variables so they overwrite the core */
48+
@import "variables";
49+
50+
/* rest of core files */
51+
@import "node_modules/castlecss-core/sass/main";
52+
@import "node_modules/castlecss-buttons/sass/main";
53+
54+
55+
/* Include your own files below this line
56+
--------------------------------------
57+
*/
58+
```

0 commit comments

Comments
 (0)