You are here

Home » API reference » Font Awesome Icons 8

README.txt in Font Awesome Icons 8

Same filename and directory in other branches
  1. 8.2 README.txt
  2. 7.3 README.txt
  3. 7 README.txt
  4. 7.2 README.txt
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Installation
 * Credits


INTRODUCTION 8.x version
------------
Font Awesome (http://fontawesome.io) is the iconic font designed for use with
Bootstrap (http://getbootstrap.com). 8.x branch is under heavy development and
is supposed to be used for testing and bug fixes only.

"fontawesome" provides integration of "Font Awesome" with Drupal. Once enabled
"Font Awesome" icon fonts could be used as:

1. Directly inside of any HTML (node/block/view/panel). Inside HTML you can
   place Font Awesome icons just about anywhere with an <i> tag.

   Example for an info icon: <i class="fa fa-info-circle"></i>

   See more examples of using "Font Awesome" within HTML at:
   http://fontawesome.io/whats-new/examples/


INSTALLATION
------------

1. Using Drush (https://github.com/drush-ops/drush#readme)

    $ drush en fontawesome

    Upon enabling, this will also attempt to download and install the library
    in `/libraries/fontawesome`. If, for whatever reason, this process
    fails, you can re-run the library install manually by first clearing Drush
    caches:

    $ drush cc drush

    and then using another drush command:-

    $ drush fa-download

2. Manually

    a. Install the "Font Awesome" library following one of these 2 options:
       - run "drush fa-download" (recommended, it will download the right
         package and extract it at the right place for you.)
       - manual install: Download & extract "Font Awesome"
         (http://fontawesome.io) and place inside
         "/libraries/fontawesome" directory. The CSS file should
         be /libraries/fontawesome/css/font-awesome.css
         Direct link for downloading latest version (current is v4.7.0) is:
         https://github.com/FortAwesome/Font-Awesome/archive/master.zip
    b. Enable the module at Administer >> Site building >> Modules.

CREDITS
-------
* Rob Loach (RobLoach) http://robloach.net
* Inder Singh (inders) http://indersingh.com | https://www.drupal.org/u/inders
* Mark Carver https://www.drupal.org/u/mark-carver
* Brian Gilbert https://drupal.org/u/realityloop
* Daniel Moberly https://drupal.org/u/danielmoberly

File

README.txt
View source 
  1. 

  2. CONTENTS OF THIS FILE

  3. ---------------------

  4. 

  5.  * Introduction

  6.  * Installation

  7.  * Credits

  8. 

  9. 

  10. INTRODUCTION 8.x version

  11. ------------

  12. Font Awesome (http://fontawesome.io) is the iconic font designed for use with

  13. Bootstrap (http://getbootstrap.com). 8.x branch is under heavy development and

  14. is supposed to be used for testing and bug fixes only.

  15. 

  16. "fontawesome" provides integration of "Font Awesome" with Drupal. Once enabled

  17. "Font Awesome" icon fonts could be used as:

  18. 

  19. 1. Directly inside of any HTML (node/block/view/panel). Inside HTML you can

  20.    place Font Awesome icons just about anywhere with an  tag.

  21. 

  22.    Example for an info icon: 

  23. 

  24.    See more examples of using "Font Awesome" within HTML at:

  25.    http://fontawesome.io/whats-new/examples/

  26. 

  27. 

  28. INSTALLATION

  29. ------------

  30. 

  31. 1. Using Drush (https://github.com/drush-ops/drush#readme)

  32. 

  33.     $ drush en fontawesome

  34. 

  35.     Upon enabling, this will also attempt to download and install the library

  36.     in `/libraries/fontawesome`. If, for whatever reason, this process

  37.     fails, you can re-run the library install manually by first clearing Drush

  38.     caches:

  39. 

  40.     $ drush cc drush

  41. 

  42.     and then using another drush command:-

  43. 

  44.     $ drush fa-download

  45. 

  46. 2. Manually

  47. 

  48.     a. Install the "Font Awesome" library following one of these 2 options:

  49.        - run "drush fa-download" (recommended, it will download the right

  50.          package and extract it at the right place for you.)

  51.        - manual install: Download & extract "Font Awesome"

  52.          (http://fontawesome.io) and place inside

  53.          "/libraries/fontawesome" directory. The CSS file should

  54.          be /libraries/fontawesome/css/font-awesome.css

  55.          Direct link for downloading latest version (current is v4.7.0) is:

  56.          https://github.com/FortAwesome/Font-Awesome/archive/master.zip

  57.     b. Enable the module at Administer >> Site building >> Modules.

  58. 

  59. CREDITS

  60. -------

  61. * Rob Loach (RobLoach) http://robloach.net

  62. * Inder Singh (inders) http://indersingh.com | https://www.drupal.org/u/inders

  63. * Mark Carver https://www.drupal.org/u/mark-carver

  64. * Brian Gilbert https://drupal.org/u/realityloop

  65. * Daniel Moberly https://drupal.org/u/danielmoberly