summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/awesomebox/README.md
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2018-11-26 21:45:02 +0000
committerKarl Berry <karl@freefriends.org>2018-11-26 21:45:02 +0000
commit11ea1f565d0ede7b7fd6b1b8bddb3801beda5dce (patch)
tree1a62f5c0cbb73d8da87497245c2d94196bda7dd6 /Master/texmf-dist/doc/latex/awesomebox/README.md
parent038a07c08873a727349b98b6fc68cca3af0fad42 (diff)
awesomebox (26nov18)
git-svn-id: svn://tug.org/texlive/trunk@49256 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.md31
1 files changed, 9 insertions, 22 deletions
diff --git a/Master/texmf-dist/doc/latex/awesomebox/README.md b/Master/texmf-dist/doc/latex/awesomebox/README.md
index c66ed3c1e28..47582479b91 100644
--- a/Master/texmf-dist/doc/latex/awesomebox/README.md
+++ b/Master/texmf-dist/doc/latex/awesomebox/README.md
@@ -1,26 +1,11 @@
Awesome Boxes is all about drawing admonition blocks around text to
inform or alert your readers about something particular. The specific
-aim of this package is to use
-[FontAwesome](http://fontawesome.io/icons/) icons to ease the
-illustration of these blocks.
-
-This means all the magic of this package only exists if you previously
-installed FontAwesome on your system and made it available for use with
-XeTeX. Yes, this package requires you to use XeLaTeX too.
+aim of this package is to use [FontAwesome 5](https://fontawesome.com)
+icons to ease the illustration of these blocks.
The idea of admonition blocks comes from the ones you can easily do with
[AsciiDoc](http://asciidoctor.org/docs/user-manual/#admonition).
-We use the previous work of Honza Ustohal on
-[fontawesome.sty](https://gist.github.com/sway/3101743) to build this
-package. However, we made two important modifications:
-
-1. we rename the internal commands of `fontawesome.sty` from `\fa` to
- `\abIcon` and the `\FA` font switch to `\ABFamily` to avoid
- collision if you want to use both of them;
-2. we remove most of the provided icons to only kept the one we really
- use in this package.
-
For more details, please refer to the
[awesomebox.pdf](https://github.com/milouse/latex-awesomebox/blob/master/awesomebox.pdf)
document.
@@ -28,10 +13,12 @@ document.
Requirements
============
-- a working XeLaTeX environment
-- the `ifxetex`, `ifluatex`, `xltxtra`, `xcolor` and `tabularx` LaTeX
- packages
-- [FontAwesome](http://fontawesome.io/icons/)
+The following LaTeX packages are required (they should be already
+included in your LaTeX distribution):
+
+- `fontawesome5`
+- `xcolor`
+- `tabu`
Installation
============
@@ -40,7 +27,7 @@ Download the `awesomebox.sty` file and put it in the same folder of the
document your are composing.
For system wide installation, please refer to the documentation of your
-XeLaTeX distribution.
+LaTeX distribution.
License
=======