Create README #112
Description
Create a first draft of RespiraCheck's README.md within this doc: https://docs.google.com/document/d/12Sb7oQty4-g5tzvQ2p2zuGBYtJdoS-74XDURmXsDn3s/edit?usp=sharing
Leave any sections that you don't know how to answer empty and highlight the title. If you feel that any sections are missing, feel free to add them under a subheading. You don't need to write in markdown format. We don’t expect you to perfectly understand everything, but we’re assigning this task because it incentivizes you to take structured notes as you understand the project for yourself, while also contributing to the project.
Acceptance Criteria - due by Wednesday, April 2:
- All sections, except for Deployment, API endpoints, Installation, and Usage are complete or semi-complete.
- The important information from our CUCAI paper has been transferred to the README.
- Any new section that seem pertinent have been added to the README
Please communicate with each other to decide who will work on which sections. Feel free to message Jennifer or Gabriel if you have any questions about anything. The goal of this draft is to have a good basis to send to UTMIST's technical writing department for further edits.