You are here

Home » API reference » Font Awesome Icons 7

README.txt in Font Awesome Icons 7

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

 * Introduction
 * Installation
 * Credits


INTRODUCTION
------------
Font Awesome (http://fontawesome.io) is the iconic font designed for use with
Bootstrap (http://getbootstrap.com). 1.x version of this module supports 
Font Awesome v3.2.1 library (http://fortawesome.github.io/Font-Awesome/3.2.1)

"fontawesome" module 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> or a <span> tag.

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

   See more examples of using "Font Awesome" within HTML at:
   http://fortawesome.github.io/Font-Awesome/3.2.1/examples/

2. Icon API (https://drupal.org/project/icon) integration:
   This module provides easy to use interfaces that quickly allow you to inject
   icons in various aspects of your Drupal site: blocks, menus, fields, filters.


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

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

    $ drush pm-enable fontawesome

    Upon enabling, this will also attempt to download and install the library
    in `sites/all/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:-

    $ 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 
         "sites/all/libraries/fontawesome" directory. The CSS file should
         be sites/all/libraries/fontawesome/css/font-awesome.css
         Direct link for downloading version 3.2.1 is: 
         http://fortawesome.github.io/Font-Awesome/3.2.1/assets/font-awesome.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

File

README.txt
View source 
  1. 

  2. CONTENTS OF THIS FILE

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

  4. 

  5.  * Introduction

  6.  * Installation

  7.  * Credits

  8. 

  9. 

  10. INTRODUCTION

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

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

  13. Bootstrap (http://getbootstrap.com). 1.x version of this module supports 

  14. Font Awesome v3.2.1 library (http://fortawesome.github.io/Font-Awesome/3.2.1)

  15. 

  16. "fontawesome" module 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  or a  tag.

  21. 

  22.    Example for an info icon: 

  23. 

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

  25.    http://fortawesome.github.io/Font-Awesome/3.2.1/examples/

  26. 

  27. 2. Icon API (https://drupal.org/project/icon) integration:

  28.    This module provides easy to use interfaces that quickly allow you to inject

  29.    icons in various aspects of your Drupal site: blocks, menus, fields, filters.

  30. 

  31. 

  32. INSTALLATION

  33. ------------

  34. 

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

  36. 

  37.     $ drush pm-enable fontawesome

  38. 

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

  40.     in `sites/all/libraries/fontawesome`. If, for whatever reason, this process

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

  42.     caches:

  43. 

  44.     $ drush cc drush

  45. 

  46.     and then using:-

  47. 

  48.     $ drush fa-download

  49. 

  50. 2. Manually

  51. 

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

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

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

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

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

  57.          "sites/all/libraries/fontawesome" directory. The CSS file should

  58.          be sites/all/libraries/fontawesome/css/font-awesome.css

  59.          Direct link for downloading version 3.2.1 is: 

  60.          http://fortawesome.github.io/Font-Awesome/3.2.1/assets/font-awesome.zip

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

  62. 

  63. CREDITS

  64. -------

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

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

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

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