Add long description to setup.py from parsing the README.md

nwb-extensions / ndx-template

A template for creating Neurodata Extensions for the NWB neurophysiology data standard

https://nwb.org/

Other

5 stars 8 forks source link

Add long description to setup.py from parsing the README.md #44

Closed oruebel closed 4 years ago

oruebel commented 4 years ago

Currently the cookiecutter does not set the long description for the package. This PR updates setup.py to by default include the text from the README.md as the long-description for the package.

rly commented 4 years ago

@oruebel I edited your change to accept both README.md (which is generated by cookiecutter) and README.rst for people who prefer to use RST. Let me know if it looks good.

rly commented 4 years ago

Closes #36 which I didn't merge earlier due to CI issues.

oruebel commented 4 years ago

Looks good. Thanks for the changes 👍