diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 67 |
1 files changed, 66 insertions, 1 deletions
@@ -1 +1,66 @@ -# latex-fontawesome5
\ No newline at end of file +latex-fontawesome5 +================= + +Original project is [furl's latex-fontawesome](https://github.com/furl/latex-fontawesome). I edited this project to use latest [FontAwesome](https://fontawesome.com/) icons in XeLaTeX. + +The current version of FontAwesome icons used is 5.0.2. + +How to Use +---------- + +### Requirements +* You must have the FontAwesome font on your machine (download from [here](https://fontawesome.com/)). +* You must be using XeLaTeX and have the `fontspec` package installed. +* You can use this package with the free and the pro fonts. +* For using the pro features, you need to buy [Font Awesome Pro](https://fontawesome.com/pro). + + +### Usage +1. Download the `fontawesome5.sty` file and put it in the same directory as the LaTeX file using the icons. +2. Exctract the `.otf` files (`use-on-desktop` directory inside the downloaded zip) into the font directory in the same directory as the LaTeX file using the icons. +3. Include the package as normal (in the preamble of the `.tex` file, add the line `\usepackage{fontawesome5}`). +4. Use an icon by typing `\faicon{address-book}`. Other icons than `address-book` can be found on the [fontawesome](https://fontawesome.com/icons?d=gallery) website. + + +### Example + +Free version +```tex +\usepackage{fontawesome5} + +\faicon{font-awesome} +Normal: \faicon{address-book} +Bold: \textbf{\faicon{address-book}} +``` + +Pro version +```tex +\usepackage[pro]{fontawesome5} + +\faicon{font-awesome} +Normal: \faicon{alarm-clock} +Bold: \textbf{\faicon{alarm-clock}} +Italic: \textit{\faicon{alarm-clock}} +``` + +Make Latest fontawesome.sty +--------------------------- + +### Requirements +* You need python to create `fontawesome5.sty` from scratch. +* Download FontAwesome from [here](https://fontawesome.com/ and exctact the zip file into `fontawesome` next to the `create_sty.py` file. + +### Usage +```bash +$ python create_sty.py +``` +This should result in the creation of latest ``fontawesome5.sty`` + + +Contact +------- + +You are free to modify it. +If you have any questions, feel free to join me. + +Good luck!
\ No newline at end of file |