Skip to content

Commit

Permalink
Use pandoc for translating md file intro rst
Browse files Browse the repository at this point in the history
  • Loading branch information
Daisuke Baba committed Jul 24, 2016
1 parent 766ca71 commit 3b8a797
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 3 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import os
import sys
import pypandoc
from setuptools import setup, find_packages

version = "1.0.0"
Expand All @@ -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=[
Expand Down

0 comments on commit 3b8a797

Please sign in to comment.