manodeep / Corrfunc

⚡️⚡️⚡️Blazing fast correlation functions on the CPU.
https://corrfunc.readthedocs.io
MIT License
163 stars 50 forks source link

README updates #285

Closed lgarrison closed 1 year ago

lgarrison commented 1 year ago

I went to the README to fix the erroneous installation instructions reported by @misharash in https://github.com/manodeep/Corrfunc/issues/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 commented 1 year ago

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)

lgarrison commented 1 year ago

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.

manodeep commented 1 year ago

@lgarrison Is this ready to merge?

lgarrison commented 1 year ago

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