Skip to content

Latest commit

 

History

History
19 lines (14 loc) · 599 Bytes

Example README.md

File metadata and controls

19 lines (14 loc) · 599 Bytes

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

Description

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

Prerequisites

  • List out the libraries imported in the script

Installing instructions

  • Explain how to setup and run your package/script in user's local machine.

Screenshot

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

Author

Name(s) of author(s).