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

Updated README #65

Merged
merged 5 commits into from Aug 11, 2021
Merged

Updated README #65

merged 5 commits into from Aug 11, 2021

Conversation

ojeda-e
Copy link
Member

@ojeda-e ojeda-e commented Aug 10, 2021

Description

This PR helps to fix #54 and gets the README ready for the first release.

Changes in this PR:

  • Added sections in the README as listed in Installation instructions #54:
  • Documentation
  • Features
  • Installation
  • Usage
  • License
    (not in that order)
  • Added a figure in docs because it looks cooler.
    Edit: Changed test_env.yaml to requirements.yaml (For installation instructions).
  • Added requirements.yaml, changes name of env from test to name: membrane-curvature.
    Then it's all more consistent.

Thanks.

@codecov
Copy link

codecov bot commented Aug 10, 2021

Codecov Report

Merging #65 (0971d63) into main (71aecab) will not change coverage.
The diff coverage is n/a.

@ojeda-e ojeda-e requested a review from orbeckst August 10, 2021 23:29
devtools/conda-envs/environment.yaml Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
Copy link
Member

@IAlibay IAlibay left a 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:
Copy link
Member

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?

Copy link
Member Author

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.

devtools/conda-envs/environment.yaml Outdated Show resolved Hide resolved
@ojeda-e ojeda-e merged commit e163629 into main Aug 11, 2021
@ojeda-e ojeda-e deleted the issue54 branch August 29, 2021 20:12
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.

Installation instructions
3 participants