Skip to content

Latest commit

Β 

History

History
26 lines (14 loc) Β· 654 Bytes

Template for README.md

File metadata and controls

26 lines (14 loc) Β· 654 Bytes

Package/Script Name

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

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

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