-
Notifications
You must be signed in to change notification settings - Fork 49
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 updates #285
README updates #285
Conversation
Should all instances of Separately, we should update the list of contributors to everyone that has contributed code (or create a significant contributions category and keep the list of names you have added) |
In most instances it won't matter, but if the I am open to suggestions on the contributors list! There aren't that many contributors, so we could list them all, but it seemed appropriate to acknowledge those who made major contributions/added new features. |
$ pytest --pyargs Corrfunc | ||
|
||
The tests may take a few minutes to run. | ||
$ python -m Corrfunc.tests |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be python -m pytest Corrfunc
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We're not actually distributing the full pytest suite as part of the pip package, so pytest doesn't really do anything. But one can still use python -m Corrfunc.tests
to invoke the simpler Python tests.
@lgarrison Is this ready to merge? |
Yep! (Sorry for the delay, was offline for the last 6 days) |
I went to the README to fix the erroneous installation instructions reported by @misharash in #284 and ended up noticing some other outdated instructions. So I did a pass on the installation instructions, incorporating many of the lessons we've learned over the last few years. Hopefully it now reflects current best practices.