| 1 | 1 |
new file mode 100644 |
| ... | ... |
@@ -0,0 +1,107 @@ |
| 1 |
+--- |
|
| 2 |
+--- |
|
| 3 |
+# [Font Awesome v{{ site.fontawesome.version }}]({{ site.fontawesome.url }}) [](https://changelog.com/podcast/226)
|
|
| 4 |
+### The iconic font and CSS framework |
|
| 5 |
+ |
|
| 6 |
+Font Awesome is a full suite of {{ icons | size }} pictographic icons for easy scalable vector graphics on websites,
|
|
| 7 |
+created and maintained by [{{ site.fontawesome.author.name }}](https://twitter.com/{{ site.fontawesome.author.twitter }}).
|
|
| 8 |
+Stay up to date with the latest release and announcements on Twitter: |
|
| 9 |
+[@{{ site.fontawesome.twitter }}](https://twitter.com/{{ site.fontawesome.twitter }}).
|
|
| 10 |
+ |
|
| 11 |
+Get started at {{ site.fontawesome.url }}!
|
|
| 12 |
+ |
|
| 13 |
+## License |
|
| 14 |
+- The Font Awesome font is licensed under the SIL OFL 1.1: |
|
| 15 |
+ - http://scripts.sil.org/OFL |
|
| 16 |
+- Font Awesome CSS, LESS, and Sass files are licensed under the MIT License: |
|
| 17 |
+ - https://opensource.org/licenses/mit-license.html |
|
| 18 |
+- The Font Awesome documentation is licensed under the CC BY 3.0 License: |
|
| 19 |
+ - https://creativecommons.org/licenses/by/3.0/ |
|
| 20 |
+- Attribution is no longer required as of Font Awesome 3.0, but much appreciated: |
|
| 21 |
+ - `Font Awesome by Dave Gandy - http://fontawesome.io` |
|
| 22 |
+- Full details: http://fontawesome.io/license/ |
|
| 23 |
+ |
|
| 24 |
+## Changelog |
|
| 25 |
+- [v4.7.0 GitHub pull request](https://github.com/FortAwesome/Font-Awesome/pull/10012) |
|
| 26 |
+- [v4.6.3 GitHub pull request](https://github.com/FortAwesome/Font-Awesome/pull/9189) |
|
| 27 |
+- [v4.6.2 GitHub pull request](https://github.com/FortAwesome/Font-Awesome/pull/9117) |
|
| 28 |
+- [v4.6.1 GitHub pull request](https://github.com/FortAwesome/Font-Awesome/pull/8962) |
|
| 29 |
+- [v4.6.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?q=milestone%3A4.6.0+is%3Aclosed) |
|
| 30 |
+- [v4.5.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?q=milestone%3A4.5.0+is%3Aclosed) |
|
| 31 |
+- [v4.4.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?q=milestone%3A4.4.0+is%3Aclosed) |
|
| 32 |
+- [v4.3.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?q=milestone%3A4.3.0+is%3Aclosed) |
|
| 33 |
+- [v4.2.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=12&page=1&state=closed) |
|
| 34 |
+- [v4.1.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=6&page=1&state=closed) |
|
| 35 |
+- [v4.0.3 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=9&page=1&state=closed) |
|
| 36 |
+- [v4.0.2 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=8&page=1&state=closed) |
|
| 37 |
+- [v4.0.1 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=7&page=1&state=closed) |
|
| 38 |
+- [v4.0.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=2&page=1&state=closed) |
|
| 39 |
+- [v3.2.1 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=5&page=1&state=closed) |
|
| 40 |
+- [v3.2.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=3&page=1&state=closed) |
|
| 41 |
+- [v3.1.1 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=4&page=1&state=closed) |
|
| 42 |
+- v3.1.0 - Added 54 icons, icon stacking styles, flipping and rotating icons, removed Sass support |
|
| 43 |
+- v3.0.2 - much improved rendering and alignment in IE7 |
|
| 44 |
+- v3.0.1 - much improved rendering in webkit, various bug fixes |
|
| 45 |
+- v3.0.0 - all icons redesigned from scratch, optimized for Bootstrap's 14px default |
|
| 46 |
+ |
|
| 47 |
+## Contributing |
|
| 48 |
+ |
|
| 49 |
+Please read through our [contributing guidelines](https://github.com/FortAwesome/Font-Awesome/blob/master/CONTRIBUTING.md). |
|
| 50 |
+Included are directions for opening issues, coding standards, and notes on development. |
|
| 51 |
+ |
|
| 52 |
+## Versioning |
|
| 53 |
+ |
|
| 54 |
+Font Awesome will be maintained under the Semantic Versioning guidelines as much as possible. Releases will be numbered |
|
| 55 |
+with the following format: |
|
| 56 |
+ |
|
| 57 |
+`<major>.<minor>.<patch>` |
|
| 58 |
+ |
|
| 59 |
+And constructed with the following guidelines: |
|
| 60 |
+ |
|
| 61 |
+* Breaking backward compatibility bumps the major (and resets the minor and patch) |
|
| 62 |
+* New additions, including new icons, without breaking backward compatibility bumps the minor (and resets the patch) |
|
| 63 |
+* Bug fixes, changes to brand logos, and misc changes bumps the patch |
|
| 64 |
+ |
|
| 65 |
+For more information on SemVer, please visit http://semver.org. |
|
| 66 |
+ |
|
| 67 |
+## Author |
|
| 68 |
+- Email: {{ site.fontawesome.author.email }}
|
|
| 69 |
+- Twitter: http://twitter.com/{{ site.fontawesome.author.twitter }}
|
|
| 70 |
+- GitHub: https://github.com/{{ site.fontawesome.author.github }}
|
|
| 71 |
+ |
|
| 72 |
+## Component |
|
| 73 |
+To include as a [component](https://github.com/componentjs/component), just run |
|
| 74 |
+ |
|
| 75 |
+ $ component install FortAwesome/Font-Awesome |
|
| 76 |
+ |
|
| 77 |
+Or add |
|
| 78 |
+ |
|
| 79 |
+ "FortAwesome/Font-Awesome": "*" |
|
| 80 |
+ |
|
| 81 |
+to the `dependencies` in your `component.json`. |
|
| 82 |
+ |
|
| 83 |
+## Hacking on Font Awesome |
|
| 84 |
+ |
|
| 85 |
+**Before you can build the project**, you must first have the following installed: |
|
| 86 |
+ |
|
| 87 |
+- [Ruby](https://www.ruby-lang.org/en/) |
|
| 88 |
+- Ruby Development Headers |
|
| 89 |
+ - **Ubuntu:** `sudo apt-get install ruby-dev` *(Only if you're __NOT__ using `rbenv` or `rvm`)* |
|
| 90 |
+ - **Windows:** [DevKit](http://rubyinstaller.org/) |
|
| 91 |
+- [Bundler](http://bundler.io/) (Run `gem install bundler` to install). |
|
| 92 |
+- [Node Package Manager (AKA NPM)](https://docs.npmjs.com/getting-started/installing-node) |
|
| 93 |
+- [Less](http://lesscss.org/) (Run `npm install -g less` to install). |
|
| 94 |
+- [Less Plugin: Clean CSS](https://github.com/less/less-plugin-clean-css) (Run `npm install -g less-plugin-clean-css` to install). |
|
| 95 |
+ |
|
| 96 |
+From the root of the repository, install the tools used to develop. |
|
| 97 |
+ |
|
| 98 |
+ $ bundle install |
|
| 99 |
+ $ npm install |
|
| 100 |
+ |
|
| 101 |
+Build the project and documentation: |
|
| 102 |
+ |
|
| 103 |
+ $ bundle exec jekyll build |
|
| 104 |
+ |
|
| 105 |
+Or serve it on a local server on http://localhost:7998/Font-Awesome/: |
|
| 106 |
+ |
|
| 107 |
+ $ bundle exec jekyll -w serve |