User Tools

Site Tools


training:software:folder_organization_of_the_repository

Folder Organization of the Repository

The FRC robot software repo uses a folder structure that makes it easier to find the code you want to modify as well as similar code that can be used as examples. Most of your work will be done in the source (src) folder, but at times you will need to look at files in other places. The src folder is broken down into a lower-level folders to organize the code. In Java this folder structure matches the package hierarchy.

There are many files and folders that are necessary for the software to build and run, but generally these are setup for you by WPILib or the robot template. Below is an example from the template along with a list of folders you where may need to work (listed from top to bottom). At times there are other miscellaneous files stored in root directory for things like settings for the dashboards or preferences.

  • Docs - the team's software instructions (The Docs Folder)
  • logs - place data log files are stored in simulation
  • deploy - place to store data files needed by the robot at run time, for example files for trajectory_following
  • robot - the top level of the Java source for the robot
  • commands - place to store classes for more extensive commands that can't be easily defined in the RobotContainer or a specific subsystem.
  • subsystems - code for the individual subsystems that work with a specific subset of the hardware
  • sim - code that is only needed for simulation_mode
  • test - code to run automated unit_tests on the software

Discussion

Enter your comment:
L I H S Y
 
training/software/folder_organization_of_the_repository.txt · Last modified: by 73.238.126.198

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki