summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/awesomebox/README.md
blob: 18adc1aac5dbc0b6bb4d363a08e063562a05e953 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
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 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).

For more details, please refer to the
[awesomebox.pdf](https://github.com/milouse/latex-awesomebox/blob/master/awesomebox.pdf)
document.

Requirements
============

The following LaTeX packages are required (they should be already
included in your LaTeX distribution):

-   `fontawesome5`
-   `xcolor`
-   `array`
-   `xparse`

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
LaTeX 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.