https://github.com/castlecss/castlecss-icons
CastleCSS icons
https://github.com/castlecss/castlecss-icons
Last synced: 11 months ago
JSON representation
CastleCSS icons
- Host: GitHub
- URL: https://github.com/castlecss/castlecss-icons
- Owner: CastleCSS
- Created: 2016-12-07T14:35:34.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-12-20T01:01:54.000Z (over 9 years ago)
- Last Synced: 2025-04-09T08:13:58.792Z (about 1 year ago)
- Language: CSS
- Homepage: http://www.castlecss.com
- Size: 30.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CastleCSS Icons Files
CastleCSS icon set via Font Awesome and Cloudflare.
## CastleCSS Framework
The icon package is part of the [CastleCSS Meta 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-icons work.
Since castlecss-icons v1.0 the castlecss-core is automatically installed into your node_modules too.
Even easier: Download the [CastleCSS Boilerplate](https://www.github.com/CastleCSS/castlecss-boilerplate). All Packages are included + examples and project setup
## How to install
- Download the [CastleCSS Boilerplate](https://www.github.com/CastleCSS/castlecss-boilerplate). All Packages are included + examples and project setup
- Install via [NPM](https://www.npmjs.com/): ```npm install castlecss-icons```
- Require it in your own NPMJS package
- Download or clone the package
## Updating files
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.
```npm update castlecss-icons```
## Documentation and examples
You can find the documentation and examples at http://www.castlecss.com and [castlecss-docs](https://github.com/CastleCSS/castlecss-docs)
## Setup
Your project should have a setup similair to this (included in the [CastleCSS Boilerplate](https://github.com/CastleCSS/castlecss-boilerplate)):
With this you make sure your own variables overwrite the castle-core variables and your setup is still updatable.
```
| Your project/
|
|-- scss/
| |-- /* Custom project specific scss files here */
| |-- Main.scss
| |
|-- node_modules/
| |
| | /* CastleCSS files included automatically here */
| | castlecss-core/
| | castlecss-icons/
| | castlecss-etc ;)/
```
### Main.scss
Your main.scss should have a setup similair to this (included in the [Full CastleCSS Boilerplate](https://github.com/CastleCSS/castlecss-boilerplate)):
```
/* core variable files */
@import "path/to/castlecss-core/sass/variables";
/* Your own variables so they overwrite the core */
@import "variables";
/* rest of core files */
@import "node_modules/castlecss-core/sass/main";
@import "node_modules/castlecss-icons/sass/main";
/* Include your own files below this line
--------------------------------------
*/
```
## Roadmap
We're currently working hard on making the CastleCSS expansions and improvements. CastleCSS is made to serve as lightweight basis for tailor made software but we do want to give you the option to install a few modules to make your life easier.
Please see the [ROADMAP.MD from the CastleCSS Meta Package](https://github.com/CastleCSS/castlecss/blob/master/ROADMAP.md) for our current plans for the future.
## Contributing
Want to contribute? We'd love your help, please take a look at the roadmap or submit new suggestions.