As a developer, I want to know what I need to set up in order to work on the project.
As a user of the algorithm, I want to know what I need to do to use the algorithm.
Acceptance Criteria:
In the README:
[ ] Description of algorithm 1
[ ] Usage instructions (including how to install)
[ ] Algorithm specifications
[ ] Development instructions (installing dependencies, setting up linter and code formatter, etc.)
User Story
As a developer, I want to know what I need to set up in order to work on the project. As a user of the algorithm, I want to know what I need to do to use the algorithm.
Acceptance Criteria:
In the README:
Additional Resources
Add attachments, external links, etc here.