This repository is part of my post: Python Project Structure, where I explain my favorite way to organize and structure Python projects. The repository works as a template with all the folders and basic python files organized already.
You can see the cheatsheet here:
Download the cheatsheet from this link: cheatsheet
Sum up your application in a few lines, 30 - 60 words. Use bold font to highlight your keywords and italic for links or references.
How to set up all requirements, versions everything needed to start running the app.
Create sub-sections if needed to divide the Installation by a hierarchy.
Explain all the steps to execute your app. Remember if it's for Linux/mac or windows or both, and help yourself with coding snippets to explain the commands.
# Example of a code snippet
python code/myapp.py -MyFlags
Errors, future updates, or beta configurations. Explain why and how it could break.
Explain the do's and don'ts of your app, what you take responsibility for, and where is the limit of its purpose.
Some extra help or clarification about the whole process. What you don't provide.
References, contact or related repositories go here.