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

Revamp the README #102

Open

leethobbit opened this issue May 28, 2024 · 0 comments

Assignees

Labels

Owner

leethobbit commented May 28, 2024 •

edited

Loading

The README was auto-generated by the Python project template I used. It is a solid base, but it desperately needs some love. In particular:

Write a Quick Start guide for deploying the application in a non-development setting.
Write a style guide, or some general contribution notes.
Keep the Roadmap up-to-date

I should first walk through fresh installation a few times to ensure the process is streamlined and reliable.

leethobbit self-assigned this

leethobbit added the documentation label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment