You are here

README.txt in Font Awesome Icons 7.3

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

 * Introduction
 * Installation
 * Credits


INTRODUCTION 7.x-3.x version
------------
Font Awesome (http://fontawesome.com) is the web's most popular icon set and
toolkit. This release of the Font Awesome Icons module supports Font Awesome
versions higher than 5.0. For older versions of Font Awesome, you should
download and install Font Awesome Icons 7.x-2.x. See the Font Awesome Icons
page on Drupal.org for more information.

"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="fas fa-camera-retro"></i>

   See more examples of using "Font Awesome" within HTML at:
   https://fontawesome.com/how-to-use/on-the-web/referencing-icons/basic-use


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

1. Using Drush 8 (http://docs.drush.org/en/8.x/install/#drupal-compatibility)

    $ drush en 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 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.com) and place inside
         "sites/all/libraries/fontawesome" directory. The JS file should
         be at sites/all/libraries/fontawesome/js/all.js
         Direct link for downloading latest version (current is v5.11.2) is:
         https://use.fontawesome.com/releases/v5.11.2/fontawesome-free-5.11.2-web.zip
    b. Enable the module at Administer >> Modules.


USAGE
_____
Font Awesome can be used in many ways - you can manually insert Font Awesome
tags wherever you see fit after enabling the module, but there are other ways
as well. See
  https://fontawesome.com/how-to-use/on-the-web/referencing-icons/basic-use
for information on basic usage.

CSS Pseudo-elements - if you are using the older version of Font Awesome, CSS
with webfonts, you can use CSS Pseudo-elements for inserting your icons rather
than the default method. See
  https://fontawesome.com/how-to-use/on-the-web/advanced/css-pseudo-elements
for more information on how to add the icons through CSS.


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
* Truls S. Yggeseth https://drupal.org/u/truls1502

File

README.txt
View source
  1. CONTENTS OF THIS FILE
  2. ---------------------
  3. * Introduction
  4. * Installation
  5. * Credits
  6. INTRODUCTION 7.x-3.x version
  7. ------------
  8. Font Awesome (http://fontawesome.com) is the web's most popular icon set and
  9. toolkit. This release of the Font Awesome Icons module supports Font Awesome
  10. versions higher than 5.0. For older versions of Font Awesome, you should
  11. download and install Font Awesome Icons 7.x-2.x. See the Font Awesome Icons
  12. page on Drupal.org for more information.
  13. "fontawesome" provides integration of "Font Awesome" with Drupal. Once enabled
  14. "Font Awesome" icon fonts could be used as:
  15. 1. Directly inside of any HTML (node/block/view/panel). Inside HTML you can
  16. place Font Awesome icons just about anywhere with an tag.
  17. Example for an info icon:
  18. See more examples of using "Font Awesome" within HTML at:
  19. https://fontawesome.com/how-to-use/on-the-web/referencing-icons/basic-use
  20. INSTALLATION
  21. ------------
  22. 1. Using Drush 8 (http://docs.drush.org/en/8.x/install/#drupal-compatibility)
  23. $ drush en fontawesome
  24. Upon enabling, this will also attempt to download and install the library
  25. in "sites/all/libraries/fontawesome". If, for whatever reason, this process
  26. fails, you can re-run the library install manually by first clearing Drush
  27. caches:
  28. $ drush cc drush
  29. and then using another drush command:-
  30. $ drush fa-download
  31. 2. Manually
  32. a. Install the "Font Awesome" library following one of these 2 options:
  33. - run "drush fa-download" (recommended, it will download the right
  34. package and extract it at the right place for you.)
  35. - manual install: Download & extract "Font Awesome"
  36. (http://fontawesome.com) and place inside
  37. "sites/all/libraries/fontawesome" directory. The JS file should
  38. be at sites/all/libraries/fontawesome/js/all.js
  39. Direct link for downloading latest version (current is v5.11.2) is:
  40. https://use.fontawesome.com/releases/v5.11.2/fontawesome-free-5.11.2-web.zip
  41. b. Enable the module at Administer >> Modules.
  42. USAGE
  43. _____
  44. Font Awesome can be used in many ways - you can manually insert Font Awesome
  45. tags wherever you see fit after enabling the module, but there are other ways
  46. as well. See
  47. https://fontawesome.com/how-to-use/on-the-web/referencing-icons/basic-use
  48. for information on basic usage.
  49. CSS Pseudo-elements - if you are using the older version of Font Awesome, CSS
  50. with webfonts, you can use CSS Pseudo-elements for inserting your icons rather
  51. than the default method. See
  52. https://fontawesome.com/how-to-use/on-the-web/advanced/css-pseudo-elements
  53. for more information on how to add the icons through CSS.
  54. CREDITS
  55. -------
  56. * Rob Loach (RobLoach) http://robloach.net
  57. * Inder Singh (inders) http://indersingh.com | https://www.drupal.org/u/inders
  58. * Mark Carver https://www.drupal.org/u/mark-carver
  59. * Brian Gilbert https://drupal.org/u/realityloop
  60. * Daniel Moberly https://drupal.org/u/danielmoberly
  61. * Truls S. Yggeseth https://drupal.org/u/truls1502