Skip to content

Latest commit

 

History

History
47 lines (27 loc) · 1.14 KB

SCRIPT_README.md

File metadata and controls

47 lines (27 loc) · 1.14 KB

[SCRIPT_NAME]

A brief description of what the script does.

Getting Started

These instructions will get you a copy of the script up and running on your local machine.

Prerequisites

List of dependencies or packages that the script requires.

Installing

Step by step instructions on how to install the required dependencies. $ pip install [PACKAGE_NAME]

Running the script

Instructions on how to run the script, the input format, and what the expected output is.

Example: $ python [SCRIPT_NAME].py [EXAMPLE_INPUT_ARGUMENTS]

Expected Input: [EXPECTED_INPUT_DESCRIPTION]

Expected Output: [EXPECTED_OUTPUT_DESCRIPTION]

Built With

  • [Python](https://www.python.org/) - The programming language used
  • [PACKAGE_NAME](LINK_TO_PACKAGE) - Dependency

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.

Author

  • [YOUR_NAME](LINK_TO_YOUR_PROFILE) - Initial work

License

This project is licensed under the MIT License. Again, make sure to replace the placeholder values with the appropriate information for each script.