We need a comprehensive Readme.md for our codebase, that explains the following:
For the code:
What functions each file covers
What the functions in each file do
What arguments are needed for a function to work
For Other Programmers
How to clone the Repo to their machines
How to establish their dev environment, etc
Reasoning
While comments have their use, the code base is chock-full of comments that explain each function. This bulks up our code base and can make it more difficult to locate methods we need to edit, not to mention debugging.
Sections
[ ] Basic Info
[ ] Overview of team goal
[ ] Language(s) Used
[ ] Software Required
Future Work
We'll need someone to do the legwork and fillout the rest of this issue. Here's the format they'll need to follow:
- [ ] Filename.java
- [ ] Method A
- [ ] What Method Does (e.g. Function *foo* takes *argument* and returns *bar*. This is used to make the robot do *amazing thing*)
- [ ] Format of arguments (Strings? Floats? etc)
- [ ] Method B
Self-explanatory functions and functions without arguments don't need to be as explicitly defined.
Feature request
Description
We need a comprehensive
Readme.mdfor our codebase, that explains the following: For the code:Reasoning
While comments have their use, the code base is chock-full of comments that explain each function. This bulks up our code base and can make it more difficult to locate methods we need to edit, not to mention debugging.
Sections
Future Work
We'll need someone to do the legwork and fillout the rest of this issue. Here's the format they'll need to follow:
Self-explanatory functions and functions without arguments don't need to be as explicitly defined.