Skip to content

Commit

Permalink
Update readme to point to BrewData repo. Fix the pandoc tool to creat…
Browse files Browse the repository at this point in the history
…e rst files
  • Loading branch information
chrisgilmerproj committed Dec 8, 2016
1 parent 539bcc6 commit 0080c4d
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 34 deletions.
16 changes: 7 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,17 +44,15 @@ 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:
To parse or build recipes you will need a directory that holds data for the
following types:

- `cereals/`
- `hops/`
- `water/`
- `yeast/`
- cereals
- hops
- water
- yeast

All the data is formatted in `*.json` files. The files are guaranteed to work
with the parsers in this library.
To help with this you can use the [BrewData](https://github.com/chrisgilmerproj/brewdata) repo.

# Units

Expand Down
21 changes: 9 additions & 12 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,18 +48,16 @@ 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:
To parse or build recipes you will need a directory that holds data for
the following types:

- ``cereals/``
- ``hops/``
- ``water/``
- ``yeast/``
- cereals
- hops
- water
- yeast

All the data is formatted in ``*.json`` files. The files are guaranteed
to work with the parsers in this library.
To help with this you can use the
`BrewData <https://github.com/chrisgilmerproj/brewdata>`__ repo.

Units
=====
Expand Down Expand Up @@ -101,8 +99,7 @@ Example:
.. code:: sh
$ source .venv/bin/activate
(.venv) $ pip install -r requirements-local.txt --upgrade
(.venv) $ make html
(.venv) $ pip install -r requirements-local.txt --upgrade && make clean html
.. |PyPI| image:: https://img.shields.io/pypi/v/brewday.svg
:target: https://pypi.python.org/pypi/brewday/0.0.6
Expand Down
13 changes: 0 additions & 13 deletions make_pypi_readme.py

This file was deleted.

6 changes: 6 additions & 0 deletions make_pypi_readme.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#! /bin/bash

# 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.

pandoc -f markdown -t rst README.md -o README.rst

0 comments on commit 0080c4d

Please sign in to comment.