From 58b4bc754bbb9f5197119cd0c124e49c05acff46 Mon Sep 17 00:00:00 2001
From: Dawsyn Schraiber <32221234+dawsynth@users.noreply.github.com>
Date: Thu, 13 Jun 2024 14:30:58 -0400
Subject: Where to begin…. (#13)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

+/- Reworked collection of altimeter related functions into altimeter class
+/- Reworked bno055 class to be imu class with minimal functionality

\- Removed external Kalman filter implementations in favor of own in house version
\- Removed any/unused files
\+ Added buffer logger for when sitting on pad for extended period of time in effort to prevent filling of flash chip
\+ Added heartbeat LED for alive status
---
 README.md | 21 ++++++++++++---------
 1 file changed, 12 insertions(+), 9 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index ae9dcec..5ebaf1d 100644
--- a/README.md
+++ b/README.md
@@ -2,27 +2,30 @@
 This is the main codebase for Rocketry at Virginia Tech's Active Drag System, also known colloquially as the ADS, for the 2023-2024 competition year. It runs primarily on a Raspberry Pi Pico, and its goal is to autonomously control the ADS' deployment during flight.
 
 `Eigen` Library, `cmake`, and `arm-none-eabi-gcc` tooling required for successful build.
-## Before Build
+
+## Clone
+
+**Note: You must initialize the git submodules prior to utilizing CMake for a proper build.**
+
 ```shell
 git clone https://github.com/RocketryVT/active-drag-system.git
 cd active-drag-system/
 git submodule update --init --recursive
 ```
 
-## BUILD
+## Build (Linux)
 ```shell
-vagrant up
-vagrant ssh
-cmake /vagrant
-cmake --build .
+cmake -B build
+cmake --build build
 ```
+In the event that your preferred IDE has trouble locating header files and/or is displaying incorrect errors, pass ```-DCMAKE_EXPORT_COMPILE_COMMANDS=true``` to the first CMake command above. Similarly, if you wish to compile the additional tools (e.g. reading flash, calibrating the IMU, etc.), pass ```-DCOMPILE_TOOLS=true``` to the first CMake command above as well.
 
-## BUILD Alternative (Windows)
+## Build (Windows)
 Enable WSL2 in windows
 Install Ubuntu 22 LTS from Windows Store
 ```shell
 sudo apt update && upgrade
-sudo apt install build-essential cmake valgrind gcc-arm-none-eabi
+sudo apt install build-essential cmake gcc-arm-none-eabi
 ```
 Then to actually build:
 ```shell
@@ -30,7 +33,7 @@ cmake -B build
 cmake --build build
 ```
 
-## BUILD Alternative (Mac)
+## Build Alternative (Mac)
 ```shell
 brew install arm-none-eabi-gcc
 ```
-- 
cgit v1.2.3