Icalicons
Icalicons are a set of beautiful icons built by @noearaujo, in order to make our life easier
To get started, checkout:
http://icalialabs.github.io/icalicons/
Table of contents
Getting started
Using icalicons is extremely easy, we've provided three quick start options:
- Download the latest release.
- Clone the repo:
git clone git@github.com:IcaliaLabs/icalicons. - Use our ruby gem.
We recommend you read the documentation for information about what icons are available to you.
Running the icons
Locally
Make sure you have nodejs installed.
To lift the project all you have to do is:
Icalicons depends on Gulp to run, so make sure you install it first. You can find installation instructions here.
After installing gulp, you need to install gulp-coffee by running:
% npm install gulp-coffee
Then:
- Clone the repo:
git clone git@github.com:IcaliaLabs/icalicons.git. - Change to the directory
cd icalicons - Run
npm install. - And finally run
gulp.
The last command will open a browser tab with http://localhost:3014.
Documentation
You can find the icons at https://icalialabs.github.io/icalicons/
Contributing
Please submit all pull requests against a separate branch. Please follow the standard for naming the variables, mixins, etc.
We use scss-lint to check for code styling, you can install it via the Gemfile by running bundle install
Make sure you have all the linting passing.
Thanks!
License
Code and documentation copyright 2016 Icalia Labs. Code released under the MIT license.
