summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/awesomebox/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/awesomebox/README.md')
-rw-r--r--Master/texmf-dist/doc/latex/awesomebox/README.md50
1 files changed, 50 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/awesomebox/README.md b/Master/texmf-dist/doc/latex/awesomebox/README.md
new file mode 100644
index 00000000000..c66ed3c1e28
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/awesomebox/README.md
@@ -0,0 +1,50 @@
+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.
+
+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.
+
+Requirements
+============
+
+- a working XeLaTeX environment
+- the `ifxetex`, `ifluatex`, `xltxtra`, `xcolor` and `tabularx` LaTeX
+ packages
+- [FontAwesome](http://fontawesome.io/icons/)
+
+Installation
+============
+
+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.
+
+License
+=======
+
+Awesome Box is released under the
+[WTFPL](http://www.wtfpl.net/txt/copying/). A copy of this license is
+distributed in this package.