diff --git a/doc/metropolistheme.dtx b/doc/metropolistheme.dtx index ddccb98..785ecf2 100644 --- a/doc/metropolistheme.dtx +++ b/doc/metropolistheme.dtx @@ -125,6 +125,7 @@ plain,setbeamercolor,metroset,setsansfont,setmonofont}, } \lstMakeShortInline| +\usepackage{metalogo} \usepackage[colorlinks=true, linkcolor=mLightBrown, @@ -173,7 +174,7 @@ By default, \themename uses \href{https://www.mozilla.org/en-US/styleguide/products/firefox-os/typeface/} {Fira Sans}, a gorgeous typeface commissioned by Mozilla and designed by \href{http://www.carrois.com/fira-3-1/}{Carrois}. For best results, you will -need the Fira typeface installed and use Xe\LaTeX{} to typeset your slides. +need the Fira typeface installed and use \XeLaTeX\ to typeset your slides. However, \themename can also be used with other typefaces and \LaTeX{} build systems. @@ -188,26 +189,36 @@ the theme even better, please get in touch there. The \subsection{Installing from CTAN} -For the regular user it is recommended to install \themename from -\href{https://www.ctan.org}{CTAN}. In case you keep your \TeX\ distribution +For most users, we recommend installing \themename from +\href{https://www.ctan.org}{CTAN}. If you keep your \TeX\ distribution up-to-date, chances are good that \themename is already installed. If it is -not, you need to update your packages. For \TeX\ Live (or Mac\TeX\ on OS X) -the following command updates all packages. +not, you need to update your packages. If your distribution is \TeX\ Live +(or Mac\TeX\ on OS X), the following command updates all packages. + +\begin{lstlisting} +tlmgr update --all +\end{lstlisting} + +If this results in an error, you may need to run it with administrative privileges: \begin{lstlisting} sudo tlmgr update --all \end{lstlisting} +Mac\TeX\ on OS X also provides a graphical interface for |tlmgr| called +\TeX\ Live Utility. + For any other distribution please refer to its documentation on how to update your packages. To get the most out of the theme you should also install the |Fira| fonts. -Yet this is not mandatory. \themename also works with the standard fonts. +However, this is not mandatory; \themename also works with the standard fonts. \subsection{Installing from GitHub} -Installing \themename, like any Beamer theme, involves four easy steps: +If you want to use the cutting-edge development version of \themename, you can +install it manually. Like any \LaTeX\ package, this involves four easy steps: \begin{description} \item[Download the source] with a |git clone| of the \href{https://github.com/matze/mtheme}{\themename repository} or as a @@ -234,11 +245,10 @@ options for advanced users: \item[|make doc|] builds this documentation manual. \item[|make demo|] builds a demo presentation to test the features of \themename. - \item[|make all|] builds the theme, manual, and demo presentation. + \item[|make all|] builds the theme and manual. \item[|make clean|] removes the files generated by |make all|. \item[|make install|] installs the theme into your local texmf folder. \item[|make uninstall|] removes the theme from your local texmf folder. - \item[|make ctan|] creates a package for CTAN distribution. \end{description} @@ -280,9 +290,9 @@ The following code shows a minimal example of a Beamer presentation using For best results, we recommend installing the fonts \href{https://github.com/mozilla/Fira}{|Fira Sans|} and |Fira Mono| -and compiling with \themename using Xe\LaTeX{} or Lua\TeX{}. +and compiling with \themename using \XeLaTeX\ or \LuaTeX. These are optional dependencies; \themename is compatible with (e.g.) -pdf\LaTeX{} and will fall back to standard fonts if |Fira Sans| or |Fira Mono| +pdf\LaTeX\ and will fall back to standard fonts if |Fira Sans| or |Fira Mono| is not installed. The packaged name of |Fira Sans| is |Fira Sans OT| in some Linux