Add doc about Font Awesome

gyli · Jun 7, 2022 · d2ae409 · d2ae409
1 parent 3dc4d13
commit d2ae409
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/docs/font_awesome_integration.rst b/docs/font_awesome_integration.rst
@@ -0,0 +1,19 @@
+Font Awesome Integration
+========================
+
+PyWaffle installs `Font Awesome
+<https://fontawesome.com/>`_ free version automatically as a package dependency.
+The package it is trying to install is the latest version of `fontawesomefree
+<https://pypi.org/project/fontawesomefree/>`_.
+
+If you would like to upgrade :code:`fontawesomefree` and use the newer version with PyWaffle, you can simply upgrade :code:`fontawesomefree` and reinstall :code:`pywaffle`. In commands, that is:
+
+::
+
+   $ pip install --upgrade fontawesomefree
+   $ pip install pywaffle
+
+By running the above commands, PyWaffle will generate a new icon mapping for the newer version :code:`fontawesomefree` under the package directory, and takes care of everything. You will be free to start using new icons!
+
+For how to use Font Awesome with PyWaffle, please see `Plot with Characters or Icons
+<examples/plot_with_characters_or_icons.md>`_.
diff --git a/docs/index.rst b/docs/index.rst
@@ -21,4 +21,5 @@ Visit PyWaffle on `Github
 
    installation
    examples
+   font_awesome_integration
    class