]> git.ipfire.org Git - thirdparty/Font-Awesome.git/commitdiff
Added build prerequisites to README to save others time and headache in the future. 6730/head
authorBrandon Sara <bsara.dev@gmail.com>
Thu, 11 Jun 2015 18:32:35 +0000 (12:32 -0600)
committerBrandon Sara <bsara.dev@gmail.com>
Thu, 11 Jun 2015 18:32:35 +0000 (12:32 -0600)
README.md
src/README.md-nobuild

index 0fe8669659dc93f6e3e37f0cbb6db0d5be528f36..173e1400af8dc286113f2300d4ad76a2f23a8b38 100644 (file)
--- 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
index 0328d3986cdb93475d7b602bb0524100529ef9c0..5eb247aa1417fcfd5751ea7d9b427786add64eb8 100644 (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