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.

Sign up for GitHub

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

Jump to bottom

Readme is not informative #3

Open
Inverseit opened this issue Nov 23, 2021 · 0 comments
Open

Readme is not informative #3

Inverseit opened this issue Nov 23, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@Inverseit
Copy link
Owner

We have to add:

  1. Add purpose, motivation, and what the project does
  2. Add how to install and run the project
  3. Add methods signatures
  4. How to contribute to the project
@Inverseit Inverseit added the documentation Improvements or additions to documentation label Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Inverseit