47 lines
1.2 KiB
Markdown
47 lines
1.2 KiB
Markdown
# << Project Title >>
|
|
## CS 445 Final Project
|
|
### << Semester, Year >>
|
|
|
|
### Team: << team name >>
|
|
<< List Team Members >>
|
|
|
|
## Getting Started
|
|
<<One paragraph of project description goes here>>
|
|
|
|
### Roadmap
|
|
<<
|
|
A list of features, function or non-functional, you would like to add in the future if you had time, i.e. Phase 2 stuff
|
|
- [ ] Add Changelog
|
|
- [ ] Add back to top links
|
|
- [ ] Add Additional Templates w/ Examples
|
|
- [ ] Add "components" document to easily copy & paste sections of the readme
|
|
>>
|
|
|
|
## SRS
|
|
[document](url to google doc)
|
|
|
|
### Prerequisites
|
|
* [Docker](https://www.docker.com/)
|
|
* <<any additional software. Be specific about versions.>>
|
|
|
|
### Installing
|
|
<<
|
|
A step by step series of examples that tell you how to get a development env running
|
|
Say what the step will be
|
|
`Give the example`
|
|
And repeat
|
|
`until finished`
|
|
End with an example of getting some output from the system, such as a menu or prompt
|
|
>>
|
|
|
|
## Built With
|
|
<< list all frameworks and modules used here >>
|
|
* [requests](https://docs.python-requests.org/en/latest/user/quickstart/#make-a-request) - request for humans
|
|
|
|
## License
|
|
<< Add a [license](https://choosealicense.com/) >>
|
|
|
|
## Acknowledgments
|
|
* Hat tip to anyone whose code was used
|
|
* Inspiration
|
|
* etc
|