aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorAaron LI <aly@aaronly.me>2019-05-06 13:35:48 +0800
committerAaron LI <aly@aaronly.me>2019-05-06 13:35:48 +0800
commit8b0a7481e6e1d854b23521f9489d9e39294ea385 (patch)
treefc53e1a1178327ed8f908dc6496b522a0edd6954 /README.md
parentb1722f8f9ddf3c4e355fb44bfa7431e992f148b2 (diff)
downloadresume-8b0a7481e6e1d854b23521f9489d9e39294ea385.tar.bz2
Document the YAML requirement of make-fontawesome5.py
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 10 insertions, 3 deletions
diff --git a/README.md b/README.md
index 8aa0176..807e590 100644
--- a/README.md
+++ b/README.md
@@ -17,9 +17,16 @@ by Alessandro Plasmati.
Font Awesome 5
--------------
-I wrote a simple tool [`make-fontawesome5.py`](fontawesome5/make-fontawesome5.py)
-to generate the LaTeX style file for using the latest **Font Awesome 5**
-(the *free* edition) in LaTeX.
+I wrote a simple tool [`make-fontawesome5.py`](fontawesome5/make-fontawesome5.py),
+which will download the latest icon list from the
+[Font Awesome](https://github.com/FortAwesome/Font-Awesome) project
+and then generate the LaTeX style file for using the latest
+**Font Awesome 5** (the *free* edition) in LaTeX.
+
+This Python script requires the [`PyYAML`](https://github.com/yaml/pyyaml)
+package, which can be installed with `pip3 install --user PyYAML`
+or `sudo apt install python3-yaml`.
+
A pre-generated style file [`fontawesome5.sty`](fontawesome5/fontawesome5.sty)
(matches Font Awesome **v5.2.0**) is also provided.