mirror of
https://github.com/shouptech/synthale.git
synced 2026-02-03 07:29:42 +00:00
51 lines
1,011 B
ReStructuredText
51 lines
1,011 B
ReStructuredText
.. image:: https://circleci.com/gh/shouptech/synthale.svg?style=shield
|
|
:target: https://circleci.com/gh/shouptech/synthale
|
|
|
|
.. image:: https://codecov.io/gh/shouptech/synthale/branch/master/graph/badge.svg
|
|
:target: https://codecov.io/gh/shouptech/synthale
|
|
|
|
|
|
Synthale
|
|
========
|
|
|
|
A python application to convert valid BeerXML_ files into Markdown files. You
|
|
can then use those Markdown files in your favorite static website generator.
|
|
|
|
.. _BeerXML: http://www.beerxml.com/
|
|
|
|
|
|
Installation
|
|
------------
|
|
|
|
Synthale requires Python 3. Install Synthale from PyPi:
|
|
|
|
::
|
|
|
|
pip3 install synthale
|
|
|
|
|
|
|
|
Usage
|
|
-----
|
|
|
|
::
|
|
|
|
$ synthale --help
|
|
Usage: synthale [OPTIONS] INPUT_PATH OUTPUT_PATH
|
|
|
|
Generate markdown files from BeerXML files.
|
|
|
|
INPUT_PATH is either a directory containing XML files, or an individual
|
|
XML file. OUTPUT_PATH is the directory to write the markdown files to.
|
|
|
|
Options:
|
|
--help Show this message and exit.
|
|
|
|
|
|
|
|
License
|
|
-------
|
|
|
|
Synthale is released under the GPLv3_ license.
|
|
|
|
.. _GPLv3: LICENSE
|