emma/synthale
1
0
Fork 0
mirror of https://github.com/shouptech/synthale.git synced 2026-02-03 07:29:42 +00:00
Code Issues Releases Wiki Activity

Documentation updates

Browse source
This commit is contained in:
Emma 2019-01-03 07:55:53 -07:00
parent b46901407a
commit db33d908a3
1 changed files with 26 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.rst
View file

@ -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
-------