Skip to content
README.md 1.1 KiB
Newer Older
nimrod's avatar
nimrod committed
# Presentation

A Dockerized presentation toolkit for building presentation from markup (like
Markdown or DOT).

## Usage

nimrod's avatar
nimrod committed
`docker run --rm -itv "$PWD:/volume" adarnimrod/presentation`
nimrod's avatar
nimrod committed

Will watch the current directory and run `make` whenever a file changes. One can
nimrod's avatar
nimrod committed
add a shell alias `alias presentation='docker run --rm -itv "$PWD:/volume"
nimrod's avatar
nimrod committed
adarnimrod/presentation'` for easier use.

See the example folder for more details.

## Contains

- [Pandoc](http://pandoc.org/)
- [Graphviz](www.graphviz.org/)
- [GNU Make](https://www.gnu.org/software/make/)
- [LuaTex](http://luatex.org/)
- [LaTeX](http://www.latex-project.org/)
nimrod's avatar
nimrod committed
- [XeTex](http://xetex.sourceforge.net/)
nimrod's avatar
nimrod committed
- [on-change](https://github.com/spelufo/on-change)
nimrod's avatar
nimrod committed
- [groff](https://www.gnu.org/software/groff/)
nimrod's avatar
nimrod committed

## License

This software is licensed under the MIT license (see `LICENSE.txt`).

## Author Information

Nimrod Adar, [contact me](mailto:nimrod@shore.co.il) or visit my [website](
https://www.shore.co.il/). Patches are welcome via [`git send-email`](
http://git-scm.com/book/en/v2/Git-Commands-Email). The repository is located
at: <https://www.shore.co.il/git/>.