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

Polish README.md #134

Merged
merged 3 commits into from
Sep 14, 2023
Merged

Polish README.md #134

merged 3 commits into from
Sep 14, 2023

Conversation

SeanBryan51
Copy link
Collaborator

@SeanBryan51 SeanBryan51 commented Sep 8, 2023

  • Replace 'CABLE benchmarking' with benchcab
  • Update description of package. E.g. benchcab does not produce plots locally, it can run more than two branches, etc.
  • Documentation link shouldn't link to 'latest'
  • Add acknowledgements
  • Add badges for documentation and conda package (see Add badges to README #108)

Fixes #133

@SeanBryan51 SeanBryan51 linked an issue Sep 8, 2023 that may be closed by this pull request
4 tasks
@codecov
Copy link

codecov bot commented Sep 8, 2023

Codecov Report

Merging #134 (44873fc) into master (093bedf) will not change coverage.
Report is 1 commits behind head on master.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #134   +/-   ##
=======================================
  Coverage   88.47%   88.47%           
=======================================
  Files          27       27           
  Lines        1527     1527           
=======================================
  Hits         1351     1351           
  Misses        176      176           

README.md Outdated Show resolved Hide resolved
Co-authored-by: Claire Carouge <claire.carouge@anu.edu.au>
@SeanBryan51 SeanBryan51 merged commit 4c28ee1 into master Sep 14, 2023
4 checks passed
@SeanBryan51 SeanBryan51 deleted the 133-polish-readme branch September 14, 2023 04:13
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.

Polish README
2 participants