git.roojs.org Git - bootswatch/blob - bower_components/font-awesome/README.md

   1 #[Font Awesome v4.0.3](http://fontawesome.io)
   2 ###the iconic font designed for Bootstrap
   3
   4 Font Awesome is a full suite of 369 pictographic icons for easy scalable vector graphics on websites, created and
   5 maintained by [Dave Gandy](http://twitter.com/davegandy). Stay up to date [@fontawesome](http://twitter.com/fontawesome).
   6
   7 Get started at http://fontawesome.io!
   8
   9 ##License
  10 - The Font Awesome font is licensed under the SIL OFL 1.1:
  11   - http://scripts.sil.org/OFL
  12 - Font Awesome CSS, LESS, and SASS files are licensed under the MIT License:
  13   - http://opensource.org/licenses/mit-license.html
  14 - The Font Awesome documentation is licensed under the CC BY 3.0 License:
  15   - http://creativecommons.org/licenses/by/3.0/
  16 - Attribution is no longer required as of Font Awesome 3.0, but much appreciated:
  17   - `Font Awesome by Dave Gandy - http://fontawesome.io`
  18 - Full details: http://fontawesome.io/license
  19
  20 ##Changelog
  21 - v3.0.0 - all icons redesigned from scratch, optimized for Bootstrap's 14px default
  22 - v3.0.1 - much improved rendering in webkit, various bug fixes
  23 - v3.0.2 - much improved rendering and alignment in IE7
  24 - v3.1.0 - Added 54 icons, icon stacking styles, flipping and rotating icons, removed SASS support
  25 - [v3.1.1 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=4&page=1&state=closed)
  26 - [v3.2.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=3&page=1&state=closed)
  27 - [v3.2.1 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=5&page=1&state=closed)
  28 - [v4.0.0 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=2&page=1&state=closed)
  29 - [v4.0.1 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=7&page=1&state=closed)
  30 - [v4.0.2 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=8&page=1&state=closed)
  31 - [v4.0.3 GitHub milestones](https://github.com/FortAwesome/Font-Awesome/issues?milestone=9&page=1&state=closed)
  32
  33 ##Versioning
  34
  35 Font Awesome will be maintained under the Semantic Versioning guidelines as much as possible. Releases will be numbered with the following format:
  36
  37 `<major>.<minor>.<patch>`
  38
  39 And constructed with the following guidelines:
  40
  41 * Breaking backward compatibility bumps the major (and resets the minor and patch)
  42 * New additions, including new icons, without breaking backward compatibility bumps the minor (and resets the patch)
  43 * Bug fixes and misc changes bumps the patch
  44
  45 For more information on SemVer, please visit http://semver.org.
  46
  47 ##Author
  48 - Email: dave@fontawesome.io
  49 - Twitter: http://twitter.com/davegandy
  50 - GitHub: https://github.com/davegandy
  51 - Work: Lead Product Designer @ http://kyru.us
  52
  53 ##Component
  54 To include as a [component](http://github.com/component/component), just run
  55
  56     $ component install FortAwesome/Font-Awesome
  57
  58 Or add
  59
  60     "FortAwesome/Font-Awesome": "*"
  61
  62 to the `dependencies` in your `component.json`.
  63
  64 ## Hacking on Font Awesome
  65
  66 From the root of the repository, install the tools used to develop.
  67
  68     $ bundle install
  69     $ npm install
  70
  71 Build the project and documentation:
  72
  73     $ bundle exec jekyll build
  74
  75 Or serve it on a local server on http://localhost:7998/Font-Awesome/:
  76
  77     $ bundle exec jekyll serve