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

Improved README #1303

Merged
merged 12 commits into from
Nov 25, 2024
Merged

Improved README #1303

merged 12 commits into from
Nov 25, 2024

Conversation

dorpvom
Copy link
Collaborator

@dorpvom dorpvom commented Nov 19, 2024

With @jstucke

  • Updated information in README
  • Restructered README for better navigation and clarity
  • Added up-to-date motivation section at the top

@dorpvom dorpvom added the docs documentation label Nov 19, 2024
@dorpvom dorpvom requested review from rhelmke and maringuu November 19, 2024 15:28
@codecov-commenter
Copy link

codecov-commenter commented Nov 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.90%. Comparing base (86a6b3f) to head (f54a46a).
Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1303      +/-   ##
==========================================
- Coverage   91.94%   91.90%   -0.04%     
==========================================
  Files         377      376       -1     
  Lines       22295    21038    -1257     
==========================================
- Hits        20499    19336    -1163     
+ Misses       1796     1702      -94     

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


🚨 Try these New Features:

@dorpvom dorpvom merged commit 28035d0 into master Nov 25, 2024
9 of 10 checks passed
@dorpvom dorpvom deleted the update-readme branch November 25, 2024 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants