diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 21 |
1 files changed, 12 insertions, 9 deletions
@@ -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 ``` |