moloch-dragon/README.md

57 lines
2.0 KiB
Markdown

## Moloch
Moloch is a simple Beamer theme suitable for anyone to use. It is
a fork of the [Moloch Theme](https://github.com/matze/mtheme).
I created the fork mainly to fix some outstanding issues
to Moloch, since the theme is no longer actively maintained.
I also wanted to simplify some of the code, for instance no longer hard-code
the use of the Fira Sans font and introduce subtitles for frames.
Have a look at the [demo slides][] to see how the theme looks.
![Sample](http://i.imgur.com/Bxu52fz.png)
## Installation
Installing Moloch from source, like any Beamer theme, involves four easy
steps:
1. **Download the source** with a `git clone` of the [repository](https://github.com/jolars/moloch).
2. **Compile the style files** by running `make sty` inside the downloaded
directory. (Or run LaTeX directly on `source/molochtheme.ins`.)
3. **Move the resulting `*.sty` files** to the folder containing your
presentation. To use Moloch with many presentations, run `make install`
or move the `*.sty` files to a folder in your TeX path instead (might require
`sudo` rights).
4. **Use the theme for your presentation** by declaring `\usetheme{moloch}` in
the preamble of your Beamer document.
## Usage
The following code shows a minimal example of a Beamer presentation using
Moloch.
```latex
\documentclass{beamer}
\usetheme{moloch}
\title{A minimal example}
\date{\today}
\author{Matthias Vogelgesang}
\institute{Centre for Modern Beamer Themes}
\begin{document}
\maketitle
\section{First Section}
\begin{frame}{First Frame}
Hello, world!
\end{frame}
\end{document}
```
## License
The theme itself is licensed under a [Creative Commons Attribution-ShareAlike
4.0 International License](http://creativecommons.org/licenses/by-sa/4.0/). This
means that if you change the theme and re-distribute it, you _must_ retain the
copyright notice header and license it under the same CC-BY-SA license. This
does not affect the presentation that you create with the theme.