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

Add contributors pictures to README, show pip install instructions in docs #185

Merged
merged 2 commits into from
Apr 12, 2023

Conversation

PicoCentauri
Copy link
Collaborator

@PicoCentauri PicoCentauri commented Apr 11, 2023

Closes #180

  1. Detailed installation and developer instructions are shown in the docs and we now link to them from the README.rst. Also, developer avatars are shown in the README.

  2. So far the pip and conda installation instructions are missing in the docs. I am using the include syntax of rst files to show these also in the docs (This is reason why I ported the README from markdown to rst).


📚 Documentation preview 📚: https://scikit-matter--185.org.readthedocs.build/en/185/

README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
docs/src/installation.rst Outdated Show resolved Hide resolved
Co-authored-by: Alexander Goscinski <[email protected]>
Copy link
Collaborator

@agoscinski agoscinski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Development information has been removed from the README and moved to the Contributing page in the docs. I am fine with it. Thanks for the work!

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.

Give contributors more visibility
2 participants