Problem
There is only documentation about setting up the project in the Projects README, although that may not neccessarily be a problem. We can work on ways to improve the README
Description
By adding a detailed description of the project, the problems associated with the project and the expected outcome just as on the outreachy website I believe the project will be more complete. if this issue is approved Would like to work with a mentor to add additional description if needed.
Additional context
Implementing this would make it that just by reading the README.md documentation you would be able to understsand the details and complete direction of the project.
Implementation
Problem
There is only documentation about setting up the project in the Projects README, although that may not neccessarily be a problem. We can work on ways to improve the README
Description
By adding a detailed description of the project, the problems associated with the project and the expected outcome just as on the outreachy website I believe the project will be more complete. if this issue is approved Would like to work with a mentor to add additional description if needed.
Additional context
Implementing this would make it that just by reading the
README.mddocumentation you would be able to understsand the details and complete direction of the project.Implementation