Skip to content

Commit

Permalink
Initial documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
BrownGenius committed Apr 24, 2024
1 parent e49f59e commit 1f2604c
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
14 changes: 14 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
This is the top-level folder for the DevilBotz robot code

The code uses Java WPILib.

# Useful Resources:
* [FRC Programming in WPILib](https://youtube.com/playlist?list=PL4GNHenJg9JD5xdRxByaZZEZP1PPajPeV&si=1dgx1ZFQP8GEq4w_)
* [Git Tutorial](https://learngitbranching.js.org/)
* [Java Tutorial](https://youtube.com/playlist?list=PLZPZq0r_RZOMhCAyywfnYLlrjiVOkdAI1&si=ImrjG_c4-wThJqy3)
* [WPILib Documentation](https://docs.wpilib.org/en/stable/)

# Directory Structure
* [src/main](src/main): All of the robot code and config files are here
* [vendordeps](vendordeps): Contains the various external libraries and versions that the code base utilizes.
* [.github/workflows](.github/workflows): Contains various GitHub automation scripts that are run automatically at various stages of the code development/integration process.
3 changes: 3 additions & 0 deletions src/main/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Directory Structure
* [deploy](deploy): Config files, resources, etc that need to be stored directly on the actual robot. These can be read using standard Java File I/O calls
* [java/frc/robot](java/frc/robot): Location of the robot's actual source code

0 comments on commit 1f2604c

Please sign in to comment.