diff --git a/README.rst b/README.rst index 4fb91b4af507348c8af3287ef0eb2c7ecb56fdc9..5b4146aaf3d44caefaaee2c15d9ea265e14c56dd 100644 --- a/README.rst +++ b/README.rst @@ -8,21 +8,24 @@ available `here <https://www.shore.co.il/blog/pages/about-me.html>`_. Dependencies ------------ -Make, pandoc, rsync, pdflatex (in `Debian texlive-latex-base` provides +Make, pandoc, rsync, pdflatex (in :code:`Debian texlive-latex-base` provides pdflatex, also 'texlive-fonts-recommended' is needed for the fonts it provides). Usage ----- -To build the pdf version (same for odt, html, docx):: +To build the pdf version (same for odt, html, docx) +.. code:: shell make pdf -To build all versions:: +To build all versions +.. code:: shell make all -To upload to webserver (includes rebuilding all versions):: +To upload to webserver (includes rebuilding all versions) +.. code:: shell make publish @@ -32,3 +35,11 @@ License This repository is licensed under the `Creative Commons Attribution 4.0 International (CC BY 4.0) license <http://creativecommons.org/licenses/by/4.0/>`_. + +Author +------ + +Nimrod Adar, `contact me <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/cgit/.