Font-Awesome

mirror of https://github.com/FortAwesome/Font-Awesome.git synced 2024-11-20 11:14:28 +00:00

The iconic SVG, font, and CSS toolkit

css font fontawesome icons svg-icons svg-sprites webfont

Go to file

davegandy 24356ebde8 upgrading docs to bootstrap 3.0.2		2013-12-02 12:54:14 -05:00
css	changing fa-asc and fa-desc names to address a naming error. #2473	2013-12-02 11:22:19 -05:00
fonts	adding plus-square-o, removing expand-o and collapse-o icons	2013-11-04 10:22:13 -05:00
less	changing fa-asc and fa-desc names to address a naming error. #2473	2013-12-02 11:22:19 -05:00
scss	changing fa-asc and fa-desc names to address a naming error. #2473	2013-12-02 11:22:19 -05:00
src	upgrading docs to bootstrap 3.0.2	2013-12-02 12:54:14 -05:00
_config.yml	upgrading docs to bootstrap 3.0.2	2013-12-02 12:54:14 -05:00
.gitignore	Removed and ignored .ruby-version	2013-08-21 11:54:47 +02:00
component.json	Bumped version to 4.0.4	2013-11-28 21:49:30 +01:00
composer.json	updating component, composer, and package	2013-10-22 22:09:07 -04:00
CONTRIBUTING.md	consistency in bullets	2013-06-17 11:00:27 -04:00
Gemfile	addressing #1250	2013-06-12 14:28:15 -04:00
Gemfile.lock	Using recess property order (Fixes #1157 )	2013-08-21 13:18:37 +02:00
package.json	Bumped version to 4.0.4	2013-11-28 21:49:30 +01:00
README.md	Update README.md	2013-11-27 17:02:09 +01:00

README.md

#Font Awesome v4.0.4 ###the iconic font designed for Bootstrap

Font Awesome is a full suite of 369 pictographic icons for easy scalable vector graphics on websites, created and maintained by Dave Gandy. Stay up to date @fontawesome.

Get started at http://fontawesome.io!

##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
v3.2.0 GitHub milestones
v3.2.1 GitHub milestones
v4.0.0 GitHub milestones
v4.0.1 GitHub milestones
v4.0.2 GitHub milestones
v4.0.3 GitHub milestones
v4.0.4 GitHub milestones

Contributing

Please read through our contributing guidelines. 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: 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, 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