1
0
Fork 0
mirror of https://github.com/shouptech/synthale.git synced 2026-02-03 07:29:42 +00:00
synthale/README.rst
2019-01-02 14:10:08 -07:00

47 lines
1.4 KiB
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 and Usage
----------------------
Please visit `the documentation`_ for installation and usage instructions.
.. _`the documentation`: https://synthale.readthedocs.io/en/latest/index.html
License
-------
Synthale is released under the GPLv3_ license.
.. _GPLv3: LICENSE
::
Copyright (C) 2019 Mike Shoup
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.