aboutsummaryrefslogtreecommitdiffstats
path: root/library/font_awesome/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'library/font_awesome/README.md')
-rw-r--r--library/font_awesome/README.md82
1 files changed, 61 insertions, 21 deletions
diff --git a/library/font_awesome/README.md b/library/font_awesome/README.md
index 6a1dc7f92..bb01dd0d6 100644
--- a/library/font_awesome/README.md
+++ b/library/font_awesome/README.md
@@ -1,34 +1,53 @@
-#[Font Awesome v3.2.1](http://fontawesome.io)
-###the iconic font designed for Bootstrap
+# [Font Awesome v4.6.1](http://fontawesome.io)
+### The iconic font and CSS framework
-Font Awesome is a full suite of 361 pictographic icons for easy scalable vector graphics on websites, created and
-maintained by [Dave Gandy](http://twitter.com/davegandy). Stay up to date [@fontawesome](http://twitter.com/fontawesome).
+Font Awesome is a full suite of 628 pictographic icons for easy scalable vector graphics on websites,
+created and maintained by [Dave Gandy](https://twitter.com/davegandy).
+Stay up to date with the latest release and announcements on Twitter:
+[@fontawesome](http://twitter.com/fontawesome).
Get started at http://fontawesome.io!
-##License
+## License
- The Font Awesome font is licensed under the SIL OFL 1.1:
- http://scripts.sil.org/OFL
-- Font Awesome CSS, LESS, and SASS files are licensed under the MIT License:
- - http://opensource.org/licenses/mit-license.html
+- Font Awesome CSS, LESS, and Sass files are licensed under the MIT License:
+ - https://opensource.org/licenses/mit-license.html
- The Font Awesome documentation is licensed under the CC BY 3.0 License:
- http://creativecommons.org/licenses/by/3.0/
- Attribution is no longer required as of Font Awesome 3.0, but much appreciated:
- `Font Awesome by Dave Gandy - http://fontawesome.io`
-- Full details: http://fontawesome.io/license
-
-##Changelog
-- v3.0.0 - all icons redesigned from scratch, optimized for Bootstrap's 14px default
-- v3.0.1 - much improved rendering in webkit, various bug fixes
-- v3.0.2 - much improved rendering and alignment in IE7
-- v3.1.0 - Added 54 icons, icon stacking styles, flipping and rotating icons, removed SASS support
-- [v3.1.1 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=4&page=1&state=closed)
-- [v3.2.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=3&page=1&state=closed)
+- Full details: http://fontawesome.io/license/
+
+## Changelog
+- [v4.6.1 GitHub pull request](https://github.com/FortAwesome/Font-Awesome/pull/8962)
+- [v4.6.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?q=milestone%3A4.6.0+is%3Aclosed)
+- [v4.5.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?q=milestone%3A4.5.0+is%3Aclosed)
+- [v4.4.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?q=milestone%3A4.4.0+is%3Aclosed)
+- [v4.3.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?q=milestone%3A4.3.0+is%3Aclosed)
+- [v4.2.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=12&page=1&state=closed)
+- [v4.1.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=6&page=1&state=closed)
+- [v4.0.3 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=9&page=1&state=closed)
+- [v4.0.2 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=8&page=1&state=closed)
+- [v4.0.1 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=7&page=1&state=closed)
+- [v4.0.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=2&page=1&state=closed)
- [v3.2.1 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=5&page=1&state=closed)
+- [v3.2.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=3&page=1&state=closed)
+- [v3.1.1 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=4&page=1&state=closed)
+- v3.1.0 - Added 54 icons, icon stacking styles, flipping and rotating icons, removed Sass support
+- v3.0.2 - much improved rendering and alignment in IE7
+- v3.0.1 - much improved rendering in webkit, various bug fixes
+- v3.0.0 - all icons redesigned from scratch, optimized for Bootstrap's 14px default
+
+## Contributing
+
+Please read through our [contributing guidelines](https://github.com/FortAwesome/Font-Awesome/blob/master/CONTRIBUTING.md).
+Included are directions for opening issues, coding standards, and notes on development.
-##Versioning
+## Versioning
-Font Awesome will be maintained under the Semantic Versioning guidelines as much as possible. Releases will be numbered with the following format:
+Font Awesome will be maintained under the Semantic Versioning guidelines as much as possible. Releases will be numbered
+with the following format:
`<major>.<minor>.<patch>`
@@ -40,14 +59,35 @@ And constructed with the following guidelines:
For more information on SemVer, please visit http://semver.org.
-##Author
+## Author
- Email: dave@fontawesome.io
- Twitter: http://twitter.com/davegandy
- GitHub: https://github.com/davegandy
-- Work: Lead Product Designer @ http://kyru.us
+
+## Component
+To include as a [component](https://github.com/componentjs/component), just run
+
+ $ component install FortAwesome/Font-Awesome
+
+Or add
+
+ "FortAwesome/Font-Awesome": "*"
+
+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
@@ -59,4 +99,4 @@ Build the project and documentation:
Or serve it on a local server on http://localhost:7998/Font-Awesome/:
- $ bundle exec jekyll serve
+ $ bundle exec jekyll -w serve