Font-Awesome/src
2015-06-23 22:19:55 -07:00
..
_includes Adding newsletter signup, updating bootstrap 2015-06-23 22:19:55 -07:00
_layouts Adding newsletter signup, updating bootstrap 2015-06-23 22:19:55 -07:00
_plugins removing debugger 2015-01-15 11:49:21 -05:00
3.2.1 Updating MaxCDN url 2015-04-17 21:01:18 -04:00
assets Adding newsletter signup, updating bootstrap 2015-06-23 22:19:55 -07:00
cheatsheet.html adding aliases to cheatsheet as well 2014-05-14 10:49:26 -05:00
CNAME renaming source directory to src 2013-06-07 12:40:09 -02:30
community.html Updated contributing.md 2014-05-27 11:04:18 +02:00
design.html renaming source directory to src 2013-06-07 12:40:09 -02:30
examples.html updating fa-spinner to addres #671, adding fa-pulse class for an 8 step animation 2015-01-22 10:48:08 -05:00
get-started.html Updating MaxCDN url 2015-04-17 21:01:18 -04:00
glyphicons-test.html first pass at changing icon- to fa- 2013-09-30 20:16:19 -04:00
icons.html adding new icons, transportation and gender categories 2015-01-20 12:56:00 -05:00
icons.yml Capitalize the "P" in WordPress 2015-05-27 18:03:53 +02:00
index.html Adding newsletter signup, updating bootstrap 2015-06-23 22:19:55 -07:00
license.html updating license wording from 'gpl compatitible' to 'gpl friendly 2014-05-14 08:41:06 -05:00
Makefile changing makefile back, updating README 2015-01-22 12:19:15 -05:00
README.md-nobuild Added build prerequisites to README to save others time and headache in the future. 2015-06-11 12:32:35 -06:00
test-2.3.2.html finishing off icon renaming, hopefully #2310 2013-11-04 11:17:24 -05:00
test.html updating fa-spinner to addres #671, adding fa-pulse class for an 8 step animation 2015-01-22 10:48:08 -05:00
thanks.html Adding newsletter signup, updating bootstrap 2015-06-23 22:19:55 -07:00
whats-new.html adding webfonts, general prep for release of new version 2014-05-14 15:02:36 -05:00

---
---
#[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 with the latest release and announcements on Twitter:
[@{{ 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

**Before you can build the project**, you must first have the following installed:

- [Ruby](https://www.ruby-lang.org/en/)
- Ruby Development Headers
  - **Ubuntu:** `sudo apt-get install ruby-dev` *(Only if you're __NOT__ using `rbenv` or `rvm`)*
  - **Windows:** [DevKit](http://rubyinstaller.org/)
- [Bundler](http://bundler.io/) (Run `gem install bundler` to install).
- [Node Package Manager (AKA NPM)](https://docs.npmjs.com/getting-started/installing-node)
- [Less](http://lesscss.org/) (Run `npm install -g less` to install).
- [Less Plugin: Clean CSS](https://github.com/less/less-plugin-clean-css) (Run `npm install -g less-plugin-clean-css` to install).

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 -w serve