Description
To make our project more approachable to users and outside contributors, we need a README.md that clearly states the goals of our project, shows any dependencies that users will need to install, and provides a "front page" for our project that allows readers to easily access other documentation that we produce.
Acceptance Criteria
- An overview of the project.
- A list of build and testing dependencies.
- Instructions for building and testing the project.
- A section for links to our documentation.
Description
To make our project more approachable to users and outside contributors, we need a README.md that clearly states the goals of our project, shows any dependencies that users will need to install, and provides a "front page" for our project that allows readers to easily access other documentation that we produce.
Acceptance Criteria