summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/awesomebox/README.md
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2019-07-30 20:59:04 +0000
committerKarl Berry <karl@freefriends.org>2019-07-30 20:59:04 +0000
commit4f9282799e6b77aab5da00b68ede2cc9a7ae33e1 (patch)
tree4c79747ef71ffb2f1d4af96444d004551db321e7 /Master/texmf-dist/doc/latex/awesomebox/README.md
parentcc092956f5bc52f3152f18ae399dbd7ad172a0e4 (diff)
awesomebox (30jul19)
git-svn-id: svn://tug.org/texlive/trunk@51776 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/awesomebox/README.md')
-rw-r--r--Master/texmf-dist/doc/latex/awesomebox/README.md22
1 files changed, 21 insertions, 1 deletions
diff --git a/Master/texmf-dist/doc/latex/awesomebox/README.md b/Master/texmf-dist/doc/latex/awesomebox/README.md
index 18adc1aac5d..97a862fa097 100644
--- a/Master/texmf-dist/doc/latex/awesomebox/README.md
+++ b/Master/texmf-dist/doc/latex/awesomebox/README.md
@@ -16,9 +16,10 @@ Requirements
The following LaTeX packages are required (they should be already
included in your LaTeX distribution):
+- `array`
- `fontawesome5`
+- `ifthen`
- `xcolor`
-- `array`
- `xparse`
Installation
@@ -30,6 +31,25 @@ document your are composing.
For system wide installation, please refer to the documentation of your
LaTeX distribution.
+Compatibility
+=============
+
+This repository also hosts the package `awesomebox-compat`, which
+depends on the `fontawesome` package, instead of `fontawesome5`. Apart
+from that, it has the exact same features set.
+
+This can be usefull for you if you want to use it with an old LaTeX
+distribution, which does not embed `fontawesome5` yet (like Overleaf
+system). To use it, download the file `awesomebox-compat.sty` in this
+repository, put it near your tex files and just replace your
+`\usepackage{awesomebox}` instruction by
+`\usepackage{awesomebox-compat}`.
+
+Be aware that icon names changes between FontAwesome and FontAwesome5
+and thus using the compatibility package may break your current files.
+FontAwesome also requires you to use XeLaTeX or LuaTeX: you cannot use
+PDFLaTeX with the compatibility package.
+
License
=======