Added build prerequisites to README to save others time and headache in the future.

This commit is contained in:
Brandon Sara 2015-06-11 12:32:35 -06:00
parent db0cc833ae
commit 22f9ddf3e2
2 changed files with 22 additions and 0 deletions

View file

@ -73,6 +73,17 @@ to the `dependencies` in your `component.json`.
## Hacking on Font Awesome
**Before you can build the project**, you must first have the following installed:
- [Ruby](https://www.ruby-lang.org/en/)
- Ruby Development Headers
- **Ubuntu:** `sudo apt-get install ruby-dev` *(Only if you're __NOT__ using `rbenv` or `rvm`)*
- **Windows:** [DevKit](http://rubyinstaller.org/)
- [Bundler](http://bundler.io/) (Run `gem install bundler` to install).
- [Node Package Manager (AKA NPM)](https://docs.npmjs.com/getting-started/installing-node)
- [Less](http://lesscss.org/) (Run `npm install -g less` to install).
- [Less Plugin: Clean CSS](https://github.com/less/less-plugin-clean-css) (Run `npm install -g less-plugin-clean-css` to install).
From the root of the repository, install the tools used to develop.
$ bundle install

View file

@ -75,6 +75,17 @@ to the `dependencies` in your `component.json`.
## Hacking on Font Awesome
**Before you can build the project**, you must first have the following installed:
- [Ruby](https://www.ruby-lang.org/en/)
- Ruby Development Headers
- **Ubuntu:** `sudo apt-get install ruby-dev` *(Only if you're __NOT__ using `rbenv` or `rvm`)*
- **Windows:** [DevKit](http://rubyinstaller.org/)
- [Bundler](http://bundler.io/) (Run `gem install bundler` to install).
- [Node Package Manager (AKA NPM)](https://docs.npmjs.com/getting-started/installing-node)
- [Less](http://lesscss.org/) (Run `npm install -g less` to install).
- [Less Plugin: Clean CSS](https://github.com/less/less-plugin-clean-css) (Run `npm install -g less-plugin-clean-css` to install).
From the root of the repository, install the tools used to develop.
$ bundle install