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 updates #285

Merged
merged 4 commits into from
Dec 7, 2022
Merged

README updates #285

merged 4 commits into from
Dec 7, 2022

Conversation

lgarrison
Copy link
Collaborator

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.

@manodeep
Copy link
Owner

Should all instances of pip be replaced with python -m pip? If so, then there are a couple of pytest references that need to be updated.

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)

@manodeep manodeep added this to the v2.5.0 milestone Nov 18, 2022
@lgarrison
Copy link
Collaborator Author

In most instances it won't matter, but if the PATH gets mixed up then using python -m pip can be more robust than pip. Likewise python -m pytest can be safer.

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
Copy link
Owner

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?

Copy link
Collaborator Author

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.

@manodeep
Copy link
Owner

@lgarrison Is this ready to merge?

@lgarrison
Copy link
Collaborator Author

Yep! (Sorry for the delay, was offline for the last 6 days)

@manodeep manodeep merged commit 80e4b46 into master Dec 7, 2022
@manodeep manodeep deleted the readme-update-nov22 branch December 7, 2022 10:11
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

Successfully merging this pull request may close these issues.

None yet

2 participants