Font-Awesome/README.md

#[Font Awesome v4.1.0](http://fontawesome.io)
###The iconic font and CSS framework

Font Awesome is a full suite of 439 pictographic icons for easy scalable vector graphics on websites, created and
maintained by [Dave Gandy](http://twitter.com/davegandy). Stay up to date [@fontawesome](http://twitter.com/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](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)

## 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: dave@fontawesome.io
- Twitter: http://twitter.com/davegandy
- GitHub: https://github.com/davegandy

##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
Bumped version number 2014-04-26 23:31:52 +08:00			`#[Font Awesome v4.1.0](http://fontawesome.io)`
changing tagline 2013-12-03 03:40:11 +08:00			`###The iconic font and CSS framework`
updating readme with contact and license info 2012-03-07 11:36:13 +08:00
updating number of icons in readme 2014-05-15 04:09:18 +08:00			`Font Awesome is a full suite of 439 pictographic icons for easy scalable vector graphics on websites, created and`
updating twitter handle to @davegandy 2013-06-26 23:41:16 +08:00			`maintained by [Dave Gandy](http://twitter.com/davegandy). Stay up to date [@fontawesome](http://twitter.com/fontawesome).`
more updating of readme 2013-05-11 06:43:34 +08:00
more updates to readme 2013-05-11 06:51:35 +08:00			`Get started at http://fontawesome.io!`
updating readme with contact and license info 2012-03-07 11:36:13 +08:00
updating main font, css, less, & license info 2013-01-02 10:37:41 +08:00			`##License`
updating readme 2013-05-11 06:27:25 +08:00			`- The Font Awesome font is licensed under the SIL OFL 1.1:`
and again 2013-05-11 06:29:45 +08:00			`- http://scripts.sil.org/OFL`
updating readme 2013-05-11 06:27:25 +08:00			`- Font Awesome CSS, LESS, and SASS files are licensed under the MIT License:`
and again 2013-05-11 06:29:45 +08:00			`- http://opensource.org/licenses/mit-license.html`
updating readme 2013-05-11 06:27:25 +08:00			`- The Font Awesome documentation is licensed under the CC BY 3.0 License:`
and again 2013-05-11 06:29:45 +08:00			`- http://creativecommons.org/licenses/by/3.0/`
updating readme 2013-05-11 06:27:25 +08:00			`- Attribution is no longer required as of Font Awesome 3.0, but much appreciated:`
and again 2013-05-11 06:29:45 +08:00			- `Font Awesome by Dave Gandy - http://fontawesome.io`
updating readme 2013-05-11 06:27:25 +08:00			`- Full details: http://fontawesome.io/license`
updating main font, css, less, & license info 2013-01-02 10:37:41 +08:00
updating version numbers 2013-01-18 01:25:51 +08:00			`##Changelog`
			`- v3.0.0 - all icons redesigned from scratch, optimized for Bootstrap's 14px default`
Minor typo fixes 2013-06-13 01:34:44 +08:00			`- v3.0.1 - much improved rendering in webkit, various bug fixes`
updating version numbers 2013-01-18 01:25:51 +08:00			`- v3.0.2 - much improved rendering and alignment in IE7`
updating readme 2013-05-10 23:50:33 +08:00			`- v3.1.0 - Added 54 icons, icon stacking styles, flipping and rotating icons, removed SASS support`
updating milestones to closed in readme 2013-05-11 07:08:01 +08:00			`- [v3.1.1 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=4&page=1&state=closed)`
attempting a shot at #739 2013-05-17 10:15:50 +08:00			`- [v3.2.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=3&page=1&state=closed)`
updating docs for 3.2.1, adding site.fontawesome.minor_version jekyll variable as a hack for now 2013-06-15 04:39:10 +08:00			`- [v3.2.1 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=5&page=1&state=closed)`
updating readme, making cheatsheet render better on wide desktop 2013-10-23 22:42:27 +08:00			`- [v4.0.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=2&page=1&state=closed)`
Bumped version number to 4.0.1 2013-10-25 03:03:50 +08:00			`- [v4.0.1 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=7&page=1&state=closed)`
updating readme for new version 2013-11-04 22:25:52 +08:00			`- [v4.0.2 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=8&page=1&state=closed)`
Updated version number Fixes #2348 2013-11-05 17:08:11 +08:00			`- [v4.0.3 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=9&page=1&state=closed)`
Bumped version number 2014-04-26 23:31:52 +08:00			`- [v4.1.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=6&page=1&state=closed)`
Update README.md Added contributing section 2013-11-28 00:02:09 +08:00
			`## 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.`
updating readme with versioning information, updating license in less files 2013-05-09 11:28:34 +08:00
			`##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`

more updates to readme 2013-05-11 06:53:39 +08:00			`For more information on SemVer, please visit http://semver.org.`
more updating of readme 2013-05-11 06:43:34 +08:00
			`##Author`
			`- Email: dave@fontawesome.io`
updating twitter handle to @davegandy 2013-06-26 23:41:16 +08:00			`- Twitter: http://twitter.com/davegandy`
more updates to readme 2013-05-11 06:53:39 +08:00			`- GitHub: https://github.com/davegandy`
more updating of readme 2013-05-11 06:43:34 +08:00
adding component package definition 2013-06-22 07:05:06 +08:00			`##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`.

Generate Less files from the icons object 2013-05-23 21:04:02 +08:00			`## 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`