summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/fonts/fontawesome5
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2018-02-16 00:08:56 +0000
committerKarl Berry <karl@freefriends.org>2018-02-16 00:08:56 +0000
commite63fcdfa34c2a5f9818b7d72ebf9a5506069ba99 (patch)
tree9cc7bda67c45a01abb3e90f638cc42cdc093879b /Master/texmf-dist/doc/fonts/fontawesome5
parent42ba42be479afb3cdef765d96c1bd0d7e689573e (diff)
fontawesome5 (15feb18)
git-svn-id: svn://tug.org/texlive/trunk@46649 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/fonts/fontawesome5')
-rw-r--r--Master/texmf-dist/doc/fonts/fontawesome5/README.md14
-rw-r--r--Master/texmf-dist/doc/fonts/fontawesome5/fontawesome5.pdfbin0 -> 139388 bytes
-rw-r--r--Master/texmf-dist/doc/fonts/fontawesome5/fontawesome5.tex76
3 files changed, 90 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/fonts/fontawesome5/README.md b/Master/texmf-dist/doc/fonts/fontawesome5/README.md
new file mode 100644
index 00000000000..f737c98d2eb
--- /dev/null
+++ b/Master/texmf-dist/doc/fonts/fontawesome5/README.md
@@ -0,0 +1,14 @@
+Support files for using Font Awesome 5 with LaTeX
+
+This package provides LaTeX support for the included "Font Awesome 5 Free" icon set. These icons were designed by Fort Awesome and released under the SIL OTL 1.1 license.
+The commercial "Pro" version is also supported, if it is installed and XeLaTeX or LuaLaTeX is used. For this font you need a paid license, for more information visit https://fontawesome.com/pro.
+More information about Font Awesome is available at https://fontawesome.com.
+
+To use an icon after the package is loaded, just enter the name of the icon in camel-case prefixed with \fa, for example `\faAddressBook` for the `address-book` icon.
+
+
+The TeX files are maintained by Marcel Krüger and are released under the LaTeX Project Public License version 1.3c.
+All included fonts are provided by @fontawesome -- http://fontawesome.com under the SIL OFL 1.1 license
+This package is not an official Font Awesome project.
+
+For bug reports, please write to tex@2krueger.de.
diff --git a/Master/texmf-dist/doc/fonts/fontawesome5/fontawesome5.pdf b/Master/texmf-dist/doc/fonts/fontawesome5/fontawesome5.pdf
new file mode 100644
index 00000000000..615aee429ca
--- /dev/null
+++ b/Master/texmf-dist/doc/fonts/fontawesome5/fontawesome5.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/fonts/fontawesome5/fontawesome5.tex b/Master/texmf-dist/doc/fonts/fontawesome5/fontawesome5.tex
new file mode 100644
index 00000000000..ab3ee051ec2
--- /dev/null
+++ b/Master/texmf-dist/doc/fonts/fontawesome5/fontawesome5.tex
@@ -0,0 +1,76 @@
+\documentclass{scrartcl}
+\usepackage{hyperref}
+\usepackage{shortvrb}
+\usepackage{metalogo}
+\usepackage{fontawesome5}
+\usepackage[utf8]{inputenc}
+\MakeShortVerb{\|}
+\begin{document}
+\title{The fontawesome5 package\thanks{This document corresponds to fontawesome5 version 5.0.6, dated 2018/02/08}}
+\author{Font Awesome\thanks{More information at \url{https://fontawesome.com}} (The font)\and Marcel Krüger\thanks{E-Mail: \href{mailto:tex@2krueger.de}{\nolinkurl{tex@2krueger.de}}} (The \LaTeX{} package)}
+\maketitle
+This package provides \LaTeX{} support for the Font Awesome 5 icons.
+
+To use Font Awesome 5 icons in your document, include the package with
+\begin{verbatim}
+ \usepackage{fontawesome5}
+\end{verbatim}
+For every icon a macro is provided: Just use the official icon names\footnote{For a full list see \url{https://fontawesome.com/cheatsheet}.} converted to CamelCase with the prefix |\fa|.
+For example to use the |hand-point-up| icon, use |\faHandPointUp|.
+For icons ending with |-alt|, append a |*| instead.
+An optional argument can be added to select the style (|solid| or |regular|).
+The default style is |solid|, it can be changed with |\faStyle{...}|
+
+Every icon can also be accessed with |\faIcon{the-icon-name}| or |\faIcon[style]{...}|.
+
+\subsection*{Example}
+\begin{verbatim}
+...
+\usepackage{fontawesome5}
+...
+\begin{document}
+...
+A simple icon: \faHandPointUp\\
+Multiple versions of the file icon:
+ \faFile~
+ \faFile*~
+ \faFile[regular]
+ \faFile*[regular].\\
+Alternative syntax:
+ \faIcon{file}~
+ \faIcon*{file}~
+ \faIcon[regular]{file}~
+ \faIcon*[regular]{file}.
+...
+\end{document}
+\end{verbatim}
+
+A simple icon: \faHandPointUp\\
+Multiple versions of the file icon: \faFile~\faFile*~\faFile[regular]~\faFile*[regular].\\
+Alternative syntax: \faIcon{file}~\faIcon*{file}~\faIcon[regular]{file}~\faIcon*[regular]{file}.
+
+\subsection*{Font Awesome Pro}
+Font Awesome 5 is available in a Free and a Pro version.
+This package uses the free version by default.
+If you own a Pro license and have the Font Awesome 5 Pro desktop fonts installed in your system font path, you can use Pro instead.
+For this, load the package with the |[pro]| option:
+\begin{verbatim}
+ \usepackage[pro]{fontawesome5}
+\end{verbatim}
+Now additional icons and the |light| style can be used.
+Pro is only supported with \XeLaTeX{} and \LuaLaTeX.
+
+\subsection*{Updates}
+This package corresponds to Font Awesome 5.0.6.
+In case there is a newer version available on the Font Awesome homepage, check for updates on \url{https://ctan.org/pkg/fontawesome5}. Should there be no corresponding update on CTAN, you can write a mail to \href{mailto:tex@2krueger.de}{\nolinkurl{tex@2krueger.de}}.
+If you use \XeLaTeX{} or \LuaLaTeX{}, you can also directly download the new Desktop Fonts from \url{https://fontawesome.com} into your \TeX{} tree. If you save them with the filenames\\
+{\ttfamily\begin{tabular}{l}
+ FontAwesome5Brands-Regular-400.otf\\
+ FontAwesome5Free-Regular-400.otf\\
+ FontAwesome5Free-Solid-900.otf
+\end{tabular}}\\
+you can start using the new files right away.
+
+\subsection*{Bugs}
+For bug reports and feature requests, write to \href{mailto:tex@2krueger.de}{\nolinkurl{tex@2krueger.de}}.
+\end{document}