From e22b40247ec56a4cf3e1eeafe66d82fa8adefd01 Mon Sep 17 00:00:00 2001 From: Corwin Perren Date: Tue, 10 Oct 2017 16:55:29 -0700 Subject: [PATCH] Updated all the readme files --- README.md | 4 ++-- cs_capstone_documents/Readme.md | 19 ++++++++++--------- firmware/Readme.md | 3 +++ ground_station/Readme.md | 10 ++++++++++ rover/Readme.md | 10 ++++++++++ 5 files changed, 35 insertions(+), 11 deletions(-) create mode 100644 firmware/Readme.md create mode 100644 ground_station/Readme.md create mode 100644 rover/Readme.md diff --git a/README.md b/README.md index 4f3dc4b..e86c9b9 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,2 @@ -# Rover_2017_2018 -Embedded, rover control, and ground station firmware and software for the 2017->2018 school year. +#H1 Rover_2017_2018 +This repository contains the embedded, rover control, and ground station firmware and software for the 2017->2018 school year. diff --git a/cs_capstone_documents/Readme.md b/cs_capstone_documents/Readme.md index 7155bd1..9391d9b 100644 --- a/cs_capstone_documents/Readme.md +++ b/cs_capstone_documents/Readme.md @@ -1,13 +1,14 @@ +#H1 CAPSTONE DOCUMENTS This folder will contain all documents for the cs capstone team. -Team Members: -Chris Pham -Ken Steinfeldt -Corwin Perren +#H2 Team Members: +* Chris Pham +* Ken Steinfeldt +* Corwin Perren -TA: -Andrew Emmott +#H2 TA: +* Andrew Emmott -Instructors: -Kevin McGrath -Kirsten Winters +#H2 Instructors: +* Kevin McGrath +* Kirsten Winters diff --git a/firmware/Readme.md b/firmware/Readme.md new file mode 100644 index 0000000..a8787c0 --- /dev/null +++ b/firmware/Readme.md @@ -0,0 +1,3 @@ +#H1 Rover Firmware +This is for any code on board micro-controllers on board the Rover. +This includes firmware for the arm, and any interface / breakout boards. \ No newline at end of file diff --git a/ground_station/Readme.md b/ground_station/Readme.md new file mode 100644 index 0000000..9cd27e1 --- /dev/null +++ b/ground_station/Readme.md @@ -0,0 +1,10 @@ +#H1 Ground Station Software +This code is for the ground station side of the Mars Rover project. + +#H3 Requirements +* Python 3.X +* PyQt5 +* ROS (Version TBD) + +#H3 How to Launch +TBD \ No newline at end of file diff --git a/rover/Readme.md b/rover/Readme.md new file mode 100644 index 0000000..56e4c20 --- /dev/null +++ b/rover/Readme.md @@ -0,0 +1,10 @@ +#H1 Rover Software +This code is what runs on the NUC onboard the Rover. +This handles everything from processing vision data to actually sending drive commands to the wheels. + +#H3 Requirements +* Python 3.X +* ROS (Version TBD) + +#H3 How to Launch +TBD \ No newline at end of file