From b002f5475b510374703bf734fb606d082baf6afd Mon Sep 17 00:00:00 2001
From: Robbie Leslie <143364684+leslier7@users.noreply.github.com>
Date: Fri, 18 Jul 2025 17:09:08 +0200
Subject: [PATCH] Create README.md

Creates a README to explain the project
---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..719f82a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# Wheelchair_code_module
+
+This ROS2 package contains the code that runs on the Jetson Nano Orin on the BAD. Its primary purpose is LiDAR data processing and navigation. It also includes a module for controlling the fan speed based on the Jetson's temperature.
+
+Here is the full list of included files:
+- Obstacle Publisher Node - Subscribes to the Mid-360 LiDAR data and processes it
+- Main - Subscribes to all the sensor data and makes navigation decisions
+- Stopping - An earlier prototype of using LiDAR detection to interupt navigation
+- Gyro - A prototype of using the IMU on the BAD to turn a number of degrees
+- Temp Monitor - Monitors the temperature of the Jetson Nano and runs the fans accordingly
+
+## Dependencies
+
+- ROS2 Humble
+- [wheelchair_sensor_msgs](https://github.com/WheelchairSeniorDesign/wheelchair_sensor_msgs)
+- Eigen
+- A Mid-360 LiDAR sensor for LiDAR data
+
+## How to install
+
+- Clone this repo into your `ros2_ws/src` folder (or other ROS2 workspace folder)
+- Run the command `colcon build` in the `ros2_ws` folder (see the ROS2 documentation for more details
+
+## How to run
+Run the command corresponding to the program that you want to run:
+- Obstacle Publisher Node - `ros2 run wheelchair_code_module obstacle_publisher_node`
+- Main - `ros2 run wheelchair_code_module wheelchair`
+- Stopping - `ros2 run wheelchair_code_module stopping`
+- Gyro - `ros2 run wheelchair_code_module gyro`
+- Temp Monitor - `ros2 run wheelchair_code_module temp_monitor`