mirror of
https://github.com/FortAwesome/Font-Awesome.git
synced 2024-11-20 11:14:28 +00:00
89 lines
3.9 KiB
Plaintext
89 lines
3.9 KiB
Plaintext
---
|
|
---
|
|
#[Font Awesome v{{ site.fontawesome.version }}]({{ site.fontawesome.url }})
|
|
###The iconic font and CSS framework
|
|
|
|
Font Awesome is a full suite of {{ icons | size }} pictographic icons for easy scalable vector graphics on websites,
|
|
created and maintained by [{{ site.fontawesome.author.name }}](http://twitter.com/{{ site.fontawesome.author.twitter }}).
|
|
Stay up to date [@{{ site.fontawesome.twitter }}](http://twitter.com/{{ site.fontawesome.twitter }}).
|
|
|
|
Get started at {{ site.fontawesome.url }}!
|
|
|
|
##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
|
|
- 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)
|
|
- [v3.2.1 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=5&page=1&state=closed)
|
|
- [v4.0.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=2&page=1&state=closed)
|
|
- [v4.0.1 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=7&page=1&state=closed)
|
|
- [v4.0.2 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=8&page=1&state=closed)
|
|
- [v4.0.3 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=9&page=1&state=closed)
|
|
- [v4.1.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=6&page=1&state=closed)
|
|
- [v4.2.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=12&page=1&state=closed)
|
|
- [v4.3.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?q=milestone%3A4.3.0+is%3Aclosed)
|
|
|
|
## 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
|
|
|
|
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>`
|
|
|
|
And constructed with the following guidelines:
|
|
|
|
* Breaking backward compatibility bumps the major (and resets the minor and patch)
|
|
* New additions, including new icons, without breaking backward compatibility bumps the minor (and resets the patch)
|
|
* Bug fixes and misc changes bumps the patch
|
|
|
|
For more information on SemVer, please visit http://semver.org.
|
|
|
|
##Author
|
|
- Email: {{ site.fontawesome.author.email }}
|
|
- Twitter: http://twitter.com/{{ site.fontawesome.author.twitter }}
|
|
- GitHub: https://github.com/{{ site.fontawesome.author.github }}
|
|
|
|
##Component
|
|
To include as a [component](http://github.com/component/component), just run
|
|
|
|
$ component install FortAwesome/Font-Awesome
|
|
|
|
Or add
|
|
|
|
"FortAwesome/Font-Awesome": "*"
|
|
|
|
to the `dependencies` in your `component.json`.
|
|
|
|
## Hacking on Font Awesome
|
|
|
|
From the root of the repository, install the tools used to develop.
|
|
|
|
$ bundle install
|
|
$ npm install
|
|
|
|
Build the project and documentation:
|
|
|
|
$ bundle exec jekyll build
|
|
|
|
Or serve it on a local server on http://localhost:7998/Font-Awesome/:
|
|
|
|
$ bundle exec jekyll serve
|