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 conda install instructions to installation.md and README.md, plus various updates to README.md #627

Conversation

Steph-Chong
Copy link
Collaborator

@Steph-Chong Steph-Chong commented Aug 7, 2024

This PR includes various updates to the README.md:

  • Removes "Using This Package" section, and instead splits the previous contents into two new sections: "Installation" and "Using scores".
  • In the new "Installation" section, adds conda installation instructions.
  • In the new "Using Scores" section: the existing worked example was moved into this section, and some new sentences about Jupyter Notebook tutorials were added.
  • Throughout README.md, updates some capitalisation for consistency
  • Throughout README.md, adds commas after "e.g." to become "e.g.," (hopefully I haven't missed any)

Because the links in the README.md also needs to work on the PyPI website, I did not use relative paths.

Also adds conda installation instructions to installation.md

@tennlee please review
@nicholasloveday if there is anything you want changed, please let me know.

Copy link
Collaborator

@nicholasloveday nicholasloveday left a comment

Choose a reason for hiding this comment

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

Thanks for adding this. Particularly the conda install instructions.

@Steph-Chong Steph-Chong changed the title Various updates to README.md, including adding conda installation instructions Add conda installation instructions to installation.md and README.md, plus various updates to README.md Aug 7, 2024
@Steph-Chong
Copy link
Collaborator Author

@nicholasloveday - I made another round of changes to installation.md, partially to address offline feedback from Tennessee and partially to fix some additional bits and pieces I noticed. Would you be happy to take a look at the new changes?

Copy link
Collaborator

@nicholasloveday nicholasloveday left a comment

Choose a reason for hiding this comment

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

The changes look good. A couple of small suggestions.

docs/installation.md Show resolved Hide resolved
docs/installation.md Outdated Show resolved Hide resolved
@Steph-Chong Steph-Chong changed the title Add conda installation instructions to installation.md and README.md, plus various updates to README.md Add conda install instructions to installation.md and README.md, plus various updates to README.md Aug 9, 2024
@tennlee tennlee merged commit 18eaf90 into nci:develop Aug 9, 2024
5 checks passed
@Steph-Chong Steph-Chong deleted the Add-conda-forge-installation-instructions-to-README.md branch August 9, 2024 08:16
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.

3 participants