diff options
| author | Elena ``of Valhalla'' Grandi <valhalla@trueelena.org> | 2020-09-21 09:24:16 +0200 |
|---|---|---|
| committer | Elena ``of Valhalla'' Grandi <valhalla@trueelena.org> | 2020-09-21 09:24:16 +0200 |
| commit | 6104ed96caf6e18bac964ddbfe3d63e83658c4f7 (patch) | |
| tree | 344428664e0a3f1b06bb9b0c6f51214fc6194ac4 | |
| parent | 5ff29c61c12886e78f89efe8a516774c12631b99 (diff) | |
README.rst (for the about page)
| -rw-r--r-- | README.rst | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..5ddafe1 --- /dev/null +++ b/README.rst @@ -0,0 +1,23 @@ +============= +Eternal Volta +============= + +An RPG setting based on slightely overpowered scientists from the Age of +Enlightenment. + +To build this document you need Sphinx_; under linux it should be +available from your package repository, otherwise see its documentation +on how to install it. + +.. _Sphinx: https://www.sphinx-doc.org/en/master/ + +Afterwards, building this document should be as easy as running:: + + make html + +in the root directory, which will create html pages in ``build/html`` +that you can open in your browser. + +Alternatively, use ``make latexpdf`` to generate a pdf in +``build/latex/eternalvolta.pdf``, or ``make epub`` to generate an epub +in ``build/epub/EternalVolta.epub``. |