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

Fill out the minimum information for the README #5

Closed
christophertubbs opened this issue Jun 13, 2024 · 0 comments · Fixed by #8
Closed

Fill out the minimum information for the README #5

christophertubbs opened this issue Jun 13, 2024 · 0 comments · Fixed by #8
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@christophertubbs
Copy link

The README is currently just the one from the template.

Someone needs to fill in the minimum amount of information, giving details on what to expect from the repo, the knowledge that we have right now, and stubs for information that will come later (such as the table from #2 and the diagrams from #3).

This would not and should not present a final draft of what the README should look like - just a replacement for the template information and enough breadcrumbs to drive progress if this repository goes dormant for one reason or another.

@christophertubbs christophertubbs added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Jun 13, 2024
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 good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant