From 8b0a7481e6e1d854b23521f9489d9e39294ea385 Mon Sep 17 00:00:00 2001 From: Aaron LI Date: Mon, 6 May 2019 13:35:48 +0800 Subject: Document the YAML requirement of make-fontawesome5.py --- README.md | 13 ++++++++++--- fontawesome5/make-fontawesome5.py | 3 ++- 2 files changed, 12 insertions(+), 4 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. diff --git a/fontawesome5/make-fontawesome5.py b/fontawesome5/make-fontawesome5.py index 0c26f30..14de6a2 100755 --- a/fontawesome5/make-fontawesome5.py +++ b/fontawesome5/make-fontawesome5.py @@ -21,10 +21,11 @@ Credits: import os import sys import argparse -import yaml import urllib.request from datetime import datetime +# Require the 'PyYAML' package (or 'python3-yaml' package on Debian) +import yaml FA_URL = "https://github.com/FortAwesome/Font-Awesome" ICONS_URL = FA_URL + "/raw/master/advanced-options/metadata/icons.yml" -- cgit v1.2.2