This is an example project for mini-projects.
-
README.md - All projects must have a README file that describes the project and documents the following:
- What is the project about
- How do clone and start using it on a user's system
- Pre-requisites for the project
- Commands for running/debugging
-
src/source - source folder contains the actual scripts/programs that make up the project.
-
requirements.txt - should contain a list of all the softwares/packages required run the project.
To run this project, clone or download this project on your computer.
Navigate to the project folder
$ cd source
Run main.py to execute the program
$ python main.py