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

De-duplicate README content and update installation instructions #274

Open
wants to merge 14 commits into
base: main
Choose a base branch
from

Conversation

matt-graham
Copy link
Collaborator

Resolves #264
Resolves #222

  • Updates README.md to make it more portable (uses absolute rather than relative links, avoids GitHub Flavour Markdown emoji references in favour of Unicode characters, adjusts some formatting and styling) to allow content to be reused.
  • Removes current separate README content for PyPI index page in .pip_readme.rst in favour of just using main README.md and updates docs/index.rst to include README.md content.
  • Installation instructions in README.md updates to reflect current approach for installing (optional) dependencies, and old installation instructions in docs/user_guide/install.rst removed.

@matt-graham matt-graham added the documentation Improvements or additions to documentation label Feb 13, 2025
Copy link

codecov bot commented Feb 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.28%. Comparing base (ea11832) to head (54c7a7d).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #274   +/-   ##
=======================================
  Coverage   96.28%   96.28%           
=======================================
  Files          32       32           
  Lines        3606     3606           
=======================================
  Hits         3472     3472           
  Misses        134      134           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update installation instrutions in readme De-duplicate README content
1 participant