deblan-mirror/Fork-Awesome

mirror of https://github.com/ForkAwesome/Fork-Awesome synced 2024-05-04 15:43:10 +02:00

Go to file

davegandy 448d3ddb7f re-writing & simplifying stacked icons, massive re-organization of less include files		2013-10-22 15:55:08 -04:00
css	re-writing & simplifying stacked icons, massive re-organization of less include files	2013-10-22 15:55:08 -04:00
fonts	adding form controls section to docs, adding radio checked icon	2013-10-22 09:58:07 -04:00
less	re-writing & simplifying stacked icons, massive re-organization of less include files	2013-10-22 15:55:08 -04:00
scss	re-writing & simplifying stacked icons, massive re-organization of less include files	2013-10-22 15:55:08 -04:00
src	re-writing & simplifying stacked icons, massive re-organization of less include files	2013-10-22 15:55:08 -04:00
.gitignore	Removed and ignored .ruby-version	2013-08-21 11:54:47 +02:00
_config.yml	doc changes to match new default icon class fa	2013-10-20 19:12:13 -04:00
component.json	Update component.json	2013-09-08 17:35:50 +01:00
composer.json	merge conficts	2013-09-30 18:22:41 -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	merge conficts	2013-09-30 18:22:41 -04:00
README.md	merge conficts	2013-09-30 18:22:41 -04:00

README.md

#Font Awesome v3.2.1 ###the iconic font designed for Bootstrap

Font Awesome is a full suite of 361 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

##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