Create README.md #83
Create README.md #83
Conversation
Work in Progress - Will finish by thursday. VAK
Not final yet, will keep updating to ensure clarity and conciseness.
| 1. Go to "https://www.jetbrains.com/products/compare/?product=idea&product=idea-ce" | ||
| 2. Install "IntelliJ Community Edition" | ||
| 3. Follow the instructions you will be prompted to | ||
| 4. Open the application for the first time | ||
| 5. Click the create project button and choose preferred folder location |
There was a problem hiding this comment.
We might just want to link to our docs for getting robot development set up for the first time:
https://wiki.yetirobotics.org/books/robot-software/page/getting-started-with-robot-development
Say something along the lines of "If this is your first time working with FRC code, follow our environment setup guide here: [link]"
README.md
Outdated
| 8. Finished! | ||
|
|
||
| Main points in this repository | ||
| 1. Basic XML Documents |
There was a problem hiding this comment.
We don't do a whole bunch with XML, we can probably remove references to it. Most of it is auto-generated, and we don't often need to look at those files.
| 1. Commands(Auto and Pivot) | ||
| Aim | ||
| Handoff | ||
| Shooter | ||
| Turn | ||
|
|
||
| 3. Constants - Exact values | ||
|
|
||
| 4. Subsystems - Includes | ||
| Arm | ||
| Elevator | ||
| Intake | ||
| Pivot | ||
| Shooter | ||
| Vision | ||
|
|
||
| 5. Utilities - Controller UTIL | ||
| Alliance | ||
| Limelight | ||
| ShooterState - Data |
There was a problem hiding this comment.
We might want to have descriptions here for what each of these classes accomplishes
There was a problem hiding this comment.
If you're unsure, feel free to ask in #programming :)
There was a problem hiding this comment.
Thanks for the all the feedback, I'll make sure to work on it :)
Co-authored-by: Drew Beamer <[email protected]>
Co-authored-by: Drew Beamer <[email protected]>
Co-authored-by: Drew Beamer <[email protected]>
Work in Progress - Will finish by thursday. VAK
README finished - will continue to update