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