From 22f9ddf3e2dfa2326455acf727bdf5d179be4531 Mon Sep 17 00:00:00 2001 From: Brandon Sara Date: Thu, 11 Jun 2015 12:32:35 -0600 Subject: [PATCH] Added build prerequisites to README to save others time and headache in the future. --- README.md | 11 +++++++++++ src/README.md-nobuild | 11 +++++++++++ 2 files changed, 22 insertions(+) diff --git a/README.md b/README.md index 0fe866965..173e1400a 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/src/README.md-nobuild b/src/README.md-nobuild index 0328d3986..5eb247aa1 100644 --- a/src/README.md-nobuild +++ b/src/README.md-nobuild @@ -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