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
Updated README #65
Updated README #65
Conversation
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.
lgtm - just the one >=
vs =>
that needs checking (approving now since I don't want to block just for that)
Installation | ||
-------------- | ||
|
||
To install from source: |
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.
So once you do your first release I assume the aim is that this will become available via pip / conda (pinging @lilyminium @orbeckst @fiona-naughton ) - I guess these instructions can be updated after the fact?
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.
Yes, correct, that's the plan. Since the README will be the cover page on PyPi, I wanted to update it first.
Description
This PR helps to fix #54 and gets the README ready for the first release.
Changes in this PR:
(not in that order)
Edit:
Changed.test_env.yaml
torequirements.yaml
(For installation instructions)requirements.yaml
,changes name of env fromtest
toname: membrane-curvature
.Then it's all more consistent.
Thanks.