Add readme for pypi and a converter

README.rst

@@ -0,0 +1,89 @@
+|PyPI| |Versions| |Build Status| |License|
+
+Brew Day
+========
+
+This repositiory is a set of utilities for the homebrewer. It should
+help in constructing and analyzing recipes. There are also command line
+utilities for brew day.
+
+The hope is to help improve your planning and execution when making
+beer.
+
+Recipe Examples
+===============
+
+To see examples of this library in action check out the ``examples/``
+directory or read the `Example README.md <./examples/README.md>`__ for
+more information.
+
+Tools
+=====
+
+To be helpful a few tools have been included. Run them thusly:
+
+.. code:: sh
+
+    $ PYTHONPATH=$PYTHONPATH: python bin/abv -h
+    $ PYTHONPATH=$PYTHONPATH: python bin/sugar -h
+    $ PYTHONPATH=$PYTHONPATH: python bin/temp -h
+    $ PYTHONPATH=$PYTHONPATH: python bin/yeast -h
+
+Charts
+======
+
+In an attempt to understand the data as it is presented in various
+brewing books and websites the ``charts/`` directory attempts to
+reproduce them using the tools of this library. Credit is given as best
+as possible to the original author. Corrections are made where possible
+to make the charts as accurate as possible.
+
+A note on Graphs
+----------------
+
+Importantly these charts are generally lists of numbers and NOT graphs.
+To limit the required dependencies of this library any graphs are kept
+in the `BrewSci <https://github.com/chrisgilmerproj/brewsci>`__ repo.
+
+Data
+====
+
+The ``data/`` directory holds data used by parsers in the repo to build
+recipes. The data was gathered using Scrapy to gather info from
+different brewing websites. The scraping code exists there along with
+the following data dirs:
+
+-  ``cereals/``
+-  ``hops/``
+-  ``water/``
+-  ``yeast/``
+
+All the data is formatted in ``*.json`` files. The files are guaranteed
+to work with the parsers in this library.
+
+Units
+=====
+
+The standard for this repository at the moment is to use Imperial Units.
+This is because most of the equations used as reference use Imperial
+Units. As tests are updated units may change to SI Units (metric). Not
+all methods work with SI Units yet.
+
+Percentages
+===========
+
+A fair number of methods require input values as a percentage. To avoid
+confusion all percentages are expected to be in decimal form between the
+number 0.0 and 1.0.
+
+There still remain some methods that return percentages not in decimal
+form, notably the ABV utilities.
+
+.. |PyPI| image:: https://img.shields.io/pypi/v/brewday.svg
+   :target: https://pypi.python.org/pypi/brewday/0.0.3
+.. |Versions| image:: https://img.shields.io/pypi/pyversions/brewday.svg
+   :target: https://img.shields.io/pypi/pyversions/brewday.svg
+.. |Build Status| image:: https://travis-ci.org/chrisgilmerproj/brewday.svg?branch=master
+   :target: https://travis-ci.org/chrisgilmerproj/brewday
+.. |License| image:: https://img.shields.io/pypi/l/brewday.svg
+   :target: https://opensource.org/licenses/MIT

make_pypi_readme.py

@@ -0,0 +1,13 @@
+#! /usr/bin/env python
+
+"""
+PyPI requires reStructureText for the README file.  This converts the README.md
+that is primarily used on Github to a README.rst file for PyPI.
+"""
+
+from pypandoc import convert
+
+
+if __name__ == "__main__":
+    with open('README.rst', 'w') as f:
+        f.write(convert('README.md', 'rst', 'md'))

setup.cfg

@@ -1,5 +1,5 @@
 [metadata]
-description-file = README.md
+description-file = README.rst
 license-file = LICENSE.txt
 
 [bdist_wheel]