summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md56
1 files changed, 53 insertions, 3 deletions
diff --git a/README.md b/README.md
index eb36387..18ec6bc 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,63 @@
# Active Drag System (ADS)
-This is the main codebase for Rocketry at Virginia Tech's Active Drag System, also known coloquially as the ADS, for the 2023-2024 competition year. It runs primarily on a BeagleBone Black, and its goal is to autonomously control the ADS' deployment during flight.
+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 BeagleBone Black, and its goal is to autonomously control the ADS' deployment during flight.
## BUILD
+```shell
+vagrant up
+vagrant ssh
+cmake /vagrant
+cmake --build .
+```
+
+## BUILD Alternative (Windows)
+Enable WSL2 in windows
+Install Ubuntu 22 LTS from Windows Store
+```shell
+sudo apt update && upgrade
+sudo apt install build-essential cmake valgrind crossbuild-essential-armhf
+sudo apt install musl musl-tools
+```
+Then to actually build:
+```shell
cmake -B build
cmake --build build/
+```
+
+## BUILD Alternative (Mac)
+```shell
+brew install arm-linux-gnueabihf-binutils
+# This installs just the arm library, you can remove x86_64 if you want those too
+brew install FiloSottile/musl-cross/musl-cross --without-x86_64 --with-arm-hf
+```
+To check if installed correctly run:
+```shell
+ls /opt/homebrew/bin | grep "musl"
+```
+you should see:
+```shell
+arm-linux-musleabihf-gcc
+arm-linux-musleabihf-g++
+```
## RUN
-cd build && src/ads
+```shell
+scp -r src/ads [email protected]:~/
+./ads
+```
## TEST
-cd build && ctest
+```shell
+scp -r test/test_ads [email protected]:~/
+./test_ads
+```
+
+## GPIO Pins
+The GPIO number is calculated by taking the GPIO chip
+number, multiplying it by 32, and then adding the offset. For example,
+GPIO1_12 = (1 × 32) + 12 = GPIO 44.
+```shell
+/sys/class/gpio/gpio44 = GPIO1_12
+``` \ No newline at end of file