REVrobotics / SPARK-MAX-Examples

Example code for SPARK MAX
BSD 3-Clause "New" or "Revised" License
106 stars 107 forks source link

Plain English readme for examples #16

Closed Billfred closed 3 years ago

Billfred commented 3 years ago

While trying to get my head wrapped around REV example code (after trying to do the same for WPILib), I found myself unsure of the intended function of some examples without digging really far into their folder structure to read the comments in /src/main/java/frc/robot/Robot.java. For example, there is little indication that the Bus Measurements example takes information from a SPARK MAX with CAN ID 1 and displays stats on SmartDashboard while it's being controlled with the Y-axis of a single joystick until you really start piecing together the code.

While I was able to figure that one out in time, a readme file higher up in that example would accelerate understanding.