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

Improve the README #395

Open

code-geek opened this issue Sep 21, 2023 · 0 comments

Contributor

code-geek commented Sep 21, 2023

Description

Remove parts that are no longer relevant
Start from scratch and add installation instruction
Add code conventions and practices followed in the codebase
Describe parts of the codebase

Implementation Considerations

If something is already documented in cookiecutter, we should either link to it or paste in the content if it's short enough.

Deliverable

Upgraded README

Dependencies

No response

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