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

Project Readme Improvements #13

Closed
viperior opened this issue Feb 18, 2022 · 0 comments · Fixed by #40
Closed

Project Readme Improvements #13

viperior opened this issue Feb 18, 2022 · 0 comments · Fixed by #40
Assignees
@viperior
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@viperior
Copy link
Owner

Improve the project readme by adding sections for common questions new visitors to a repository will have:

  • What is this for?
  • How do I build it?
  • How do I run it?
  • How do I test it?
  • Links to related resources, repositories, articles, etc.
@viperior viperior self-assigned this Feb 18, 2022
@viperior viperior added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 25, 2022
@viperior viperior mentioned this issue May 6, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@viperior viperior

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Documentation and testing improvements viperior/python-project-template
1 participant
@viperior