readme_template.md

Package/Script Name

Aim

The main aim of the project you want to achieve.

Purpose

What's the purpose of this project

Short description of package/script

• If package, list of functionalities/scripts it can perform
• If standalone script, short description of script explaining what it achieves.
• List out the libraries imported.

Workflow of the Project

Add the workflow of the project point by point to get good understanding of the program

Setup instructions

Explain how to setup and run your package/script in user's system

Detailed explanation of script, if needed

If code is not explainable using comments, use this sections to explain your script

Compilation Steps

Briefly show the compilation steps of the project

Output

Display images/gifs/videos of output/result of your script so that users can visualize it

Conclusion

Provide overall summary and proper conclusion to your project

Author(s)

Name(s) of author(s)

Disclaimers, if any

Use this section to mention if any particular disclaimer is required