MDAnalysis / membrane-curvature

MDAnalysis tool to calculate membrane curvature.

https://membrane-curvature.readthedocs.io/

GNU General Public License v3.0

29 stars 6 forks source link

Updated README #65

Closed ojeda-e closed 3 years ago

ojeda-e commented 3 years ago

Description

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

Changes in this PR:

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

Thanks.

codecov[bot] commented 3 years ago

Codecov Report

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