readme1_template.md

Package/Script Name

Aim

The main aim of the script you want to achieve.

Purpose

What's the purpose of this script

Short description of package/script

• Give a short introduction about the 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 script point by point to get good understanding of the program

Detailed explanation of script, if needed

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

Setup instructions

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

Compilation Steps

Briefly show the compilation steps of the script

Sample Test Cases

Provide 2-3 sample test cases of the project

Output

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

Author(s)

Name(s) of author(s)

Disclaimers, if any

Use this section to mention if any particular disclaimer is required