Merge pull request #2 from truher/main

move docs to docs directory, fiddle with readme's
Team100 · Dec 26, 2024 · 8b3cb96 · 8b3cb96
2 parents 8aa8c4d + e78781d
commit 8b3cb96
Show file tree

Hide file tree

Showing 38 changed files with 23 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -1,31 +1,20 @@
-# all25
-
 [![CI](https://github.com/Team100/all25/actions/workflows/main.yml/badge.svg)](https://github.com/Team100/all25/actions/workflows/main.yml)
 [![CI](https://github.com/Team100/all25/actions/workflows/lib.yml/badge.svg)](https://github.com/Team100/all25/actions/workflows/lib.yml)
 [![CI](https://github.com/Team100/all25/actions/workflows/raspberry_pi.yml/badge.svg)](https://github.com/Team100/all25/actions/workflows/raspberry_pi.yml)
 
 
-all25 contains *all* the Team 100 code for *2025.*  There's just one repository,
-so that sharing library code across projects is easier.
-
-This style of code management is sometimes called a ["monorepo"](https://en.wikipedia.org/wiki/Monorepo) if you want to read more about it.
-
-Here is the directory layout:
+What's here:
 
-* **lib**: evergreen RoboRIO library code
 * **comp**: RoboRIO competition code for 2025
-* **raspberry_pi** coprocessor tasks: vision, logging, GTSAM
-* **studies**: small independent projects
-  * your project
-  * another project
+* **doc**: Documentation: look here for instructions!
+* **lib**: Evergreen RoboRIO library code
+* **raspberry_pi** Coprocessor tasks: vision, logging, GTSAM
+* **studies**: Small independent projects
+  * Your project
+  * Another project
   * etc ...
 
-# Getting Started
-
-First time working on Control? Fret not! This guide will walk you through everything from setting up your development environment, to deploying code to the RoboRIO, to controlling your first motor, and then to building a complex robot. It's an in-progress guide so please add to it anytime you see gaps.
-
-Chapters:
-1. [Setting up your development environment](README_1_STARTING.md)
-2. [Getting your first motor running](README_2_MOTOR.md)
-3. [Creating a new 'study'](README_3_STUDY.md)
+all25 contains *all* the Team 100 code for *2025.*  There's just one repository,
+so that sharing library code across projects is easier.
 
+This style of code management is sometimes called a ["monorepo"](https://en.wikipedia.org/wiki/Monorepo) if you want to read more about it.
diff --git a/doc/README.md b/doc/README.md
@@ -0,0 +1,13 @@
+# doc
+
+Documentation for Team100 control engineering software.
+
+## Getting Started
+
+First time working on Control? Fret not! This guide will walk you through everything from setting up your development environment, to deploying code to the RoboRIO, to controlling your first motor, and then to building a complex robot. It's an in-progress guide so please add to it anytime you see gaps.
+
+Chapters:
+1. [Setting up your development environment](README_1_STARTING.md)
+2. [Getting your first motor running](README_2_MOTOR.md)
+3. [Creating a new 'study'](README_3_STUDY.md)
+
diff --git a/README_1_STARTING.md → doc/README_1_STARTING.md b/README_1_STARTING.md → doc/README_1_STARTING.md
diff --git a/README_2_MOTOR.md → doc/README_2_MOTOR.md b/README_2_MOTOR.md → doc/README_2_MOTOR.md
diff --git a/README_3_STUDY.md → doc/README_3_STUDY.md b/README_3_STUDY.md → doc/README_3_STUDY.md
diff --git a/README_4_MOTOR_CONTROL.md → doc/README_4_MOTOR_CONTROL.md b/README_4_MOTOR_CONTROL.md → doc/README_4_MOTOR_CONTROL.md
diff --git a/README_N_IDENTITY.md → doc/README_N_IDENTITY.md b/README_N_IDENTITY.md → doc/README_N_IDENTITY.md
diff --git a/readme_img/all_green_driver_station.png → doc/readme_img/all_green_driver_station.png b/readme_img/all_green_driver_station.png → doc/readme_img/all_green_driver_station.png
diff --git a/readme_img/can_bus_flowing.png → doc/readme_img/can_bus_flowing.png b/readme_img/can_bus_flowing.png → doc/readme_img/can_bus_flowing.png
diff --git a/readme_img/drag_keyboard.png → doc/readme_img/drag_keyboard.png b/readme_img/drag_keyboard.png → doc/readme_img/drag_keyboard.png
diff --git a/readme_img/driver_station.png → doc/readme_img/driver_station.png b/readme_img/driver_station.png → doc/readme_img/driver_station.png
diff --git a/readme_img/field_view.png → doc/readme_img/field_view.png b/readme_img/field_view.png → doc/readme_img/field_view.png
diff --git a/readme_img/log_level.png → doc/readme_img/log_level.png b/readme_img/log_level.png → doc/readme_img/log_level.png
diff --git a/readme_img/motor_log_statements.png → doc/readme_img/motor_log_statements.png b/readme_img/motor_log_statements.png → doc/readme_img/motor_log_statements.png
diff --git a/readme_img/neo_motor.jpg → doc/readme_img/neo_motor.jpg b/readme_img/neo_motor.jpg → doc/readme_img/neo_motor.jpg
diff --git a/readme_img/nice_traj.png → doc/readme_img/nice_traj.png b/readme_img/nice_traj.png → doc/readme_img/nice_traj.png
diff --git a/readme_img/openworkspace.png → doc/readme_img/openworkspace.png b/readme_img/openworkspace.png → doc/readme_img/openworkspace.png
diff --git a/readme_img/readme_img.png → doc/readme_img/readme_img.png b/readme_img/readme_img.png → doc/readme_img/readme_img.png
diff --git a/readme_img/rev_hardware_client.png → doc/readme_img/rev_hardware_client.png b/readme_img/rev_hardware_client.png → doc/readme_img/rev_hardware_client.png
diff --git a/readme_img/rev_hardware_client_working.png → ...eadme_img/rev_hardware_client_working.png b/readme_img/rev_hardware_client_working.png → ...eadme_img/rev_hardware_client_working.png
diff --git a/readme_img/rio_log.png → doc/readme_img/rio_log.png b/readme_img/rio_log.png → doc/readme_img/rio_log.png
diff --git a/readme_img/run_motor.png → doc/readme_img/run_motor.png b/readme_img/run_motor.png → doc/readme_img/run_motor.png
diff --git a/readme_img/sim_gui.png → doc/readme_img/sim_gui.png b/readme_img/sim_gui.png → doc/readme_img/sim_gui.png
diff --git a/readme_img/spark_controller_voltage.png → doc/readme_img/spark_controller_voltage.png b/readme_img/spark_controller_voltage.png → doc/readme_img/spark_controller_voltage.png
diff --git a/readme_img/spark_max.jpg → doc/readme_img/spark_max.jpg b/readme_img/spark_max.jpg → doc/readme_img/spark_max.jpg
diff --git a/readme_img/spark_max_black.jpg → doc/readme_img/spark_max_black.jpg b/readme_img/spark_max_black.jpg → doc/readme_img/spark_max_black.jpg
diff --git a/readme_img/spark_max_rio.jpg → doc/readme_img/spark_max_rio.jpg b/readme_img/spark_max_rio.jpg → doc/readme_img/spark_max_rio.jpg
diff --git a/readme_img/study_added_to_vscode.png → doc/readme_img/study_added_to_vscode.png b/readme_img/study_added_to_vscode.png → doc/readme_img/study_added_to_vscode.png
diff --git a/readme_img/team_100_logo.png → doc/readme_img/team_100_logo.png b/readme_img/team_100_logo.png → doc/readme_img/team_100_logo.png
diff --git a/readme_img/test_project_success.png → doc/readme_img/test_project_success.png b/readme_img/test_project_success.png → doc/readme_img/test_project_success.png
diff --git a/readme_img/ugly_traj.png → doc/readme_img/ugly_traj.png b/readme_img/ugly_traj.png → doc/readme_img/ugly_traj.png
diff --git a/readme_img/usb_1.jpg → doc/readme_img/usb_1.jpg b/readme_img/usb_1.jpg → doc/readme_img/usb_1.jpg
diff --git a/readme_img/usb_2.jpg → doc/readme_img/usb_2.jpg b/readme_img/usb_2.jpg → doc/readme_img/usb_2.jpg
diff --git a/readme_img/view_console.png → doc/readme_img/view_console.png b/readme_img/view_console.png → doc/readme_img/view_console.png
diff --git a/readme_img/workspace.png → doc/readme_img/workspace.png b/readme_img/workspace.png → doc/readme_img/workspace.png
diff --git a/readme_img/wpilib_deploy.png → doc/readme_img/wpilib_deploy.png b/readme_img/wpilib_deploy.png → doc/readme_img/wpilib_deploy.png
diff --git a/readme_img/wpilib_new_project.png → doc/readme_img/wpilib_new_project.png b/readme_img/wpilib_new_project.png → doc/readme_img/wpilib_new_project.png
diff --git a/readme_img/wpilib_new_project_settings.png → ...eadme_img/wpilib_new_project_settings.png b/readme_img/wpilib_new_project_settings.png → ...eadme_img/wpilib_new_project_settings.png