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

Project summary should say what it does #747

Open
1 of 2 tasks
yavin5 opened this issue Oct 27, 2024 · 2 comments
Open
1 of 2 tasks

Project summary should say what it does #747

yavin5 opened this issue Oct 27, 2024 · 2 comments

Comments

@yavin5
Copy link

yavin5 commented Oct 27, 2024

System Info

All

Information

  • The official example scripts
  • My own modified scripts

🐛 Describe the bug

The first sentence of the project summary should say what it does. The current one says it's like another project that readers are entirely unfamiliar with because we ignore everything Google does.

Error logs

None

Expected behavior

Reading the very first sentence of the project Readme says what the project implements and maybe a bulleted list of features under that.

@init27
Copy link
Contributor

init27 commented Oct 27, 2024

@yavin5 can you please clarify which ReadMe are you referring to please?

@yavin5
Copy link
Author

yavin5 commented Oct 27, 2024 via email

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

No branches or pull requests

2 participants