!! Change this document for your own project by removing the placeholder text, adding your own text, adding helpful sections etc. etc. !!
In a few sentences describe what your project is trying to solve.
You can use GitHub markdown notation or GitLab markdown notation in case you are using one of these platforms. This will give a nicely formatted documentation when looking at your project online.
Explain what the user has to type to get started with your solution. Which one is the main Python file? In the simplest case, this could look something like this:
python main.py
In other cases the user might first have to install some project dependencies first has to run something like this (a sample requirements.txt file is also included in the project template):
pip install -r requirements.txt
Explain any high level concepts that you are using in your software. What were your ideas for creating the whole software? What might not be apparent from the sources alone? You can also add diagrams, photos of whiteboards or flipcharts or even crudly drawing napkin sketches of the core concepts of your software when they are readable and helpful for understanding.