Skip to content

[Enhance] Update README #26

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

Merged
merged 6 commits into from
Aug 5, 2023
Merged

[Enhance] Update README #26

merged 6 commits into from
Aug 5, 2023

Conversation

okotaku
Copy link
Owner

@okotaku okotaku commented Aug 4, 2023

Motivation

Related issue: #24

Checklist

Before PR:

  • Pre-commit or other linting tools are used to fix the potential lint issues.
  • Bug fixes are fully covered by unit tests, the case that causes the bug should be added in the unit tests.
  • The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
  • The documentation has been modified accordingly, like docstring or example tutorials.

@okotaku okotaku self-assigned this Aug 4, 2023
@okotaku okotaku mentioned this pull request Aug 4, 2023
Copy link

@Ezra-Yu Ezra-Yu left a comment

Choose a reason for hiding this comment

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

Look Good!

A little suggestion:

  1. Using emoji may make readme more interesting, such as https://github.com/open-mmlab/mmyolo

  2. A picture in the introduction that presents what this repo does.

@okotaku
Copy link
Owner Author

okotaku commented Aug 5, 2023

@Ezra-Yu Thank you for your kind reviews!

@okotaku okotaku merged commit 8afdd1b into main Aug 5, 2023
@okotaku okotaku deleted the feat/update_readme branch August 5, 2023 05:04
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