3 ms·
Why spoil an awesome project with a poor README? Compare with https://github.com/rails/rails#getting-started https://github.com/rails/rails#getting-started * W
by mattgibson 11y ago
Why spoil an awesome project with a poor README? Compare with https://github.com/rails/rails#getting-started https://github.com/rails/rails#getting-started
* What are the system prerequisites?
* What are the optional command line params?
* What is an example of the expected output?
* How does it (roughly) work?
* Why not use actual markdown to highlight the code in the README.md file.
I feel bad highlighting this as it looks really interesting, but as Python is not one of my main languages I don't feel much enthusiasm for spending an unknown amount of time just trying to make sense of the demo, which is a shame.
- seanhandley 11y agoSorry to say I agree. At the very least, a requirements.txt would be nice.
- leeny 11y agoI had to do the following to get this working: - install scikit-learn (http://scikit-learn.org/stable/install.html http://scikit-learn.org/stable/install.html) - install nltk (http://www.nltk.org/install.html http://www.nltk.org/install.html) - download data set: http://www.cs.cornell.edu/home/llee/data/convote.html http://www.cs.cornell.edu/home/llee/data/convote.html - put data set in convote_v1.1/ - fix the path in demo.py to point to the data set (you might have to change backslash to forward slash depending on your environment)