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

Update README with logo and documentation #61

Merged
merged 2 commits into from
Jul 25, 2024

Conversation

jenna-tomkinson
Copy link
Member

@jenna-tomkinson jenna-tomkinson commented Jul 25, 2024

Description

In this PR, I have updated the main README for the repo to include the logo, some widgets, and a description with what coSMicQC is all about. It is bare bones and will benefit from future figures or a gif of how it works (great idea from Dave!). I look forward to any and all feedback!

What kind of change(s) are included?

  • Feature (adds or updates new capabilities)
  • Bug fix (fixes an issue).
  • Enhancement (adds functionality).
  • Breaking change (these changes would cause existing functionality to not work as expected).

Checklist

Please ensure that all boxes are checked before indicating that this pull request is ready for review.

  • I have read and followed the CONTRIBUTING.md guidelines.
  • I have searched for existing content to ensure this is not a duplicate.
  • I have performed a self-review of these additions (including spelling, grammar, and related).
  • These changes pass all pre-commit checks.
  • I have added comments to my code to help provide understanding
  • I have added a test which covers the code changes found within this PR
  • I have deleted all non-relevant text in this pull request template.

@jenna-tomkinson jenna-tomkinson requested a review from d33bs July 25, 2024 21:04
Copy link
Member

@d33bs d33bs left a comment

Choose a reason for hiding this comment

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

Nice work! I've added a few comments and suggestions which I'll leave up to you. Overall LGTM! Please don't hesitate to let me know if you have any questions.

@jenna-tomkinson
Copy link
Member Author

@d33bs Thank you lots for the review! I am merging now, so excited to now have a nicer README 😄

@jenna-tomkinson jenna-tomkinson merged commit 5451acb into WayScience:main Jul 25, 2024
10 of 11 checks passed
@jenna-tomkinson jenna-tomkinson deleted the update_main_README branch July 25, 2024 22:36
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.

2 participants