Simple one-line overview of use / purpose of the project.
- Summary
- Getting started
- Prerequisites
- Installation
- How-to Run
- Git Branching Strategy
- Help
- Folder Contents
<Brief overview of the purpose of the project and it's benefit>
<List of technologies used, e.g. AWS, Python, Snowflake>
<Describe any prerequisites libraries / configuration / other needed for the project, e.g.:>
Before you begin, ensure you have met the following requirements:
- You have installed the latest version of <coding_language/dependency/requirement_1>
- You have a <Mac/Windows>
- How / where to download your program
- Any modifications needed to be made to files / folders
- How to run the program
- Step-by-step bullets
code blocks for commands
See docs/git_branching_strategy.md.
Describe troubleshooting steps for common problems or issues. E.g.
commands to run if specific messages are encountered
Folder | Description |
---|---|
folder | Contains files related to... |
folder | Contains files related to... |
This is an adapted version of the following README.