setupy.py: read("README") should be read("README.md")

mwilliamson / spur.py

Run commands and manipulate files locally or over SSH using the same interface

BSD 2-Clause "Simplified" License

267 stars 37 forks source link

setupy.py: read("README") should be read("README.md") #12

Closed jenisys closed 10 years ago

jenisys commented 10 years ago

Version: Bleading Edge from Github repository.

Also run "tox -e py27" that runs into the same problem,

mwilliamson commented 10 years ago

README is used instead of README.md since PyPI expects restructured text. Try running make README to generate the file.

jenisys commented 10 years ago

Mmh, makes no sense if "README" is not checked in. Therefore, you cannot clone your repository and just use it. I need first install pandoc and run your makefile before I can install the package.

NOTE: Close the issue, if you think that this is not a problem. I just stumbled over it.

mwilliamson commented 10 years ago

I decided it's easier if we just always use rst. I normally prefer using Markdown, but it's not worth the extra complexity.