Fork-Awesome/src
2016-04-12 12:22:13 -04:00
..
3.2.1 Correct spelling ('sumarily' should be 'summarily'). 2015-12-15 07:40:54 +00:00
_includes Slight low vision rephrasing, added color contrast checker resource 2016-04-12 12:22:13 -04:00
_layouts Fix aria-hidden 2016-04-12 13:05:53 +01:00
_plugins Icon pages should generate. Silly me. 2016-01-10 21:39:43 -05:00
assets Merge branch '4.6.0-wip' 2016-04-11 13:47:51 -04:00
test Updating visual test cases to prep for #8101 2016-04-08 17:42:14 -05:00
accessibility.html Adding assistive-listening-systems #5409 2016-04-06 17:41:33 -05:00
cheatsheet.html adding accessibility information and best practices 2016-04-06 09:29:31 -05:00
CNAME renaming source directory to src 2013-06-07 12:40:09 -02:30
community.html adding accessibility information and best practices 2016-04-06 09:29:31 -05:00
design.html renaming source directory to src 2013-06-07 12:40:09 -02:30
examples.html adding accessibility information and best practices 2016-04-06 09:29:31 -05:00
get-started.html adding accessibility information and best practices 2016-04-06 09:29:31 -05:00
icons.html Merge branch '4.6.0-wip' 2016-04-11 13:47:51 -04:00
icons.yml Adding snapchat (#3906) & viadeo (#886) icons 2016-04-11 11:08:03 -04:00
index.html Adding newsletter signup, updating bootstrap 2015-06-23 22:19:55 -07:00
license.html adding accessibility information and best practices 2016-04-06 09:29:31 -05:00
Makefile Fix less version 2015-07-28 14:52:04 -07:00
README.md-nobuild First edits to files that depend on version number. 2016-04-06 09:23:21 -05:00
survey.html creating and populating Font Awesome survey view 2016-02-24 16:01:23 -05:00
thanks.html changing references of 'fonticons' to 'fort awesome' 2016-04-06 17:12:51 -05:00
whats-new.html Updating what's new, another webfont file 2016-04-11 13:39:25 -04: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 }}](https://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:
  - https://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
- [v4.6.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?q=milestone%3A4.6.0+is%3Aclosed)
- [v4.5.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?q=milestone%3A4.5.0+is%3Aclosed)
- [v4.4.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?q=milestone%3A4.4.0+is%3Aclosed)
- [v4.3.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?q=milestone%3A4.3.0+is%3Aclosed)
- [v4.2.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=12&page=1&state=closed)
- [v4.1.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=6&page=1&state=closed)
- [v4.0.3 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=9&page=1&state=closed)
- [v4.0.2 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=8&page=1&state=closed)
- [v4.0.1 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=7&page=1&state=closed)
- [v4.0.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=2&page=1&state=closed)
- [v3.2.1 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=5&page=1&state=closed)
- [v3.2.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=3&page=1&state=closed)
- [v3.1.1 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=4&page=1&state=closed)
- v3.1.0 - Added 54 icons, icon stacking styles, flipping and rotating icons, removed Sass support
- v3.0.2 - much improved rendering and alignment in IE7
- v3.0.1 - much improved rendering in webkit, various bug fixes
- v3.0.0 - all icons redesigned from scratch, optimized for Bootstrap's 14px default

## 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](https://github.com/componentjs/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