Python Development Project Readme Template

[pratyush-giri]

Readme Creation👷

Create a README.md file in your folder, example Peter_Solutions/README.md and add the required packages to be installed before running the program. Below are the points that are to be properly mentioned in your readme.

1. Project Explanation with Title🚀

Describe the explanation in your words with a proper title of the project, which can be too precise and short.

2. Problem Solving🤯

• Try to mention your project plans and implementation.
• Be precise and try to maintain the required factors.

3. Mention the Tech - Stack 👨‍💻👩‍💻

Be precise and be as clear as possible with your tech - stack

Project submission

based on the level and complicacy of the projects ,you are advised to add your project folder for eg:- YOUR_NAME/xyz.py to the to the respective projects_Intermediate/PYTHON_DEVELOPEMENT or projects_Advanced/PYTHON_DEVELOPEMENT . Your folder should contain following information:-

• The requirements.txt file
• The .gitignore file
• The python src file

The deciding factors for the level of your projects solely depends upon the technical stacks used in it. Below are some level specific projects similar to which your projects will be considered or else will be rejected .

Intermediate level example

• TIC TAC TOE GAME
• ROCK PAPER SCISSORS
• GUI CALCULATOR

Advanced level example

• CHATBOT
• FACE MASK DETECTION

Suggestion if any 📝

Tell us what better can be implemented

If new can refer to the following instructions and start contribution Contribution Guide 🤝