From db33d908a3ea115c453e41714a3dc992099e3c81 Mon Sep 17 00:00:00 2001 From: Mike Shoup Date: Thu, 3 Jan 2019 07:55:53 -0700 Subject: [PATCH] Documentation updates --- README.rst | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index ef52da5..59ad6b1 100644 --- a/README.rst +++ b/README.rst @@ -4,6 +4,11 @@ .. image:: https://codecov.io/gh/shouptech/synthale/branch/master/graph/badge.svg :target: https://codecov.io/gh/shouptech/synthale +.. image:: https://badge.fury.io/py/synthale.svg + :target: https://pypi.org/project/synthale/ + + + Synthale ======== @@ -17,11 +22,31 @@ can then use those Markdown files in your favorite static website generator. Installation and Usage ---------------------- -Please visit `the documentation`_ for installation and usage instructions. +If you have Python 3.5 or newer installed, install via pip: + +:: + + pip install synthale + +To actually use the thing, use the `generate` command: + +:: + + synthale generate --help + +More thorough instructions can be found at `the documentation`_. .. _`the documentation`: https://synthale.readthedocs.io/en/latest/index.html +Developing +---------- + +Please see the documentation on `contributing`_ for information on how to +develop Synthale. + +.. _`contributing`: https://synthale.readthedocs.io/en/latest/contributing.html + License -------