Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme lacks installation instructions #12

Open
robert-dodier opened this issue Sep 11, 2019 · 1 comment
Open

Readme lacks installation instructions #12

robert-dodier opened this issue Sep 11, 2019 · 1 comment

Comments

@robert-dodier
Copy link

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?

@gregversteeg
Copy link
Owner

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants