diff --git a/README.md b/README.md index e4263e4..f5f15be 100644 --- a/README.md +++ b/README.md @@ -17,13 +17,27 @@ $ pip install candy-board-cli $ pip candy-board-cli ``` -## Local Installation test +## Development + +### Prerequisites + + * [pandoc](http://pandoc.org) + * [pypandoc](https://pypi.python.org/pypi/pypandoc/1.2.0) + +On Mac OS: + +``` +$ brew install pandoc +$ pip install pypandoc +``` + +### Local Installation test ``` $ ./setup.py install --record files.txt ``` -## Local Uninstallation test +### Local Uninstallation test ``` $ cat files.txt | xargs rm -rf diff --git a/setup.py b/setup.py index c61bc2f..afbe8da 100755 --- a/setup.py +++ b/setup.py @@ -2,6 +2,7 @@ import os import sys +import pypandoc from setuptools import setup, find_packages version = "1.0.0" @@ -19,7 +20,7 @@ url='http://github.com/CANDY-LINE/candy-board-cli', download_url='https://github.com/CANDY-LINE/candy-board-cli/tarball/{0}'.format(version), description='CANDY Board Service CLI', - long_description=open('README.md').read() + '\n\n' + open('LICENSE').read(), + long_description=pypandoc.convert('README.md', 'rst'), license='BSD3', scripts=['bin/candy'], classifiers=[