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

Populate Readme #2

Closed
sergefdrv opened this issue Mar 10, 2023 · 1 comment · Fixed by #4
Closed

Populate Readme #2

sergefdrv opened this issue Mar 10, 2023 · 1 comment · Fixed by #4
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@sergefdrv
Copy link
Member

Now there's very little stuff on project's Readme. This is to be rectified shortly by providing details essential for understanding the point of the project and its goals.

@sergefdrv sergefdrv added the documentation Improvements or additions to documentation label Mar 10, 2023
@sergefdrv sergefdrv self-assigned this Mar 10, 2023
@sergefdrv
Copy link
Member Author

sergefdrv commented Mar 14, 2023

The initial ReadMe should have the following sections:

  • About - what it is
  • Status - where it is
  • Goals - what it's gonna achieve
  • Purpose - what it's for
  • Approach - how it's gonna develop
  • Contributing - how to get involved
  • License

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant