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

Add proper README #9

Open
cjuracek opened this issue Jan 14, 2024 · 0 comments
Open

Add proper README #9

cjuracek opened this issue Jan 14, 2024 · 0 comments
Labels
final An issue to take on only when everything else is finished

Comments

@cjuracek
Copy link
Owner

The README is not currently informative. It should contain:

Required

  • A brief overview of the project
  • Where to find the writeup
  • Installation instructions
  • How to demo

Nice to haves
@cjuracek cjuracek added bug Something isn't working final An issue to take on only when everything else is finished and removed bug Something isn't working labels Jan 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
final An issue to take on only when everything else is finished
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@cjuracek