From 1f2604cc76a5a262269a9bec584331c49dc7d14d Mon Sep 17 00:00:00 2001 From: Nilesh Agarwalla Date: Wed, 24 Apr 2024 10:05:30 -0400 Subject: [PATCH] Initial documentation --- readme.md | 14 ++++++++++++++ src/main/readme.md | 3 +++ 2 files changed, 17 insertions(+) create mode 100644 readme.md create mode 100644 src/main/readme.md diff --git a/readme.md b/readme.md new file mode 100644 index 00000000..4787fb68 --- /dev/null +++ b/readme.md @@ -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. \ No newline at end of file diff --git a/src/main/readme.md b/src/main/readme.md new file mode 100644 index 00000000..40759826 --- /dev/null +++ b/src/main/readme.md @@ -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 \ No newline at end of file