NPEET icon indicating copy to clipboard operation
NPEET copied to clipboard

Readme lacks installation instructions

Open robert-dodier opened this issue 6 years ago • 1 comments

The readme file lacks installation instructions -- I think it would be very helpful to include that.

I was able to puzzle out that

$ python3 setup.py build
$ python3 setup.py install

are enough to build and install the package. Maybe that info, or something like it, could be in the readme.

Also, I found that after installing, import entropy_estimators fails, but import npeet.entropy_estimators succeeds. The readme mentions the former, should it contain the latter instead?

robert-dodier avatar Sep 11 '19 20:09 robert-dodier

Thanks for the comment. Sorry, I wrote this before I was very savvy about python programming. Even better would be a "pip install npeet". I will try to get someone to look at this, but it probably wouldn't happen soon. Feel free to update the documentation and I'll merge the changes.

gregversteeg avatar Sep 11 '19 21:09 gregversteeg