diff --git a/README.md b/README.md index dedaddd..aff845d 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,73 @@ -# Multi-Tracker +# Multi-Tracker(LINX) ## Description ## BOM(Bill of Materials) +- [adafruit feather 32U4 RFM95](https://www.adafruit.com/product/3079) +- [ ST7789V2 1.69" LCD Display](https://www.waveshare.com/1.69inch-lcd-module.htm) +- [24 x WS2812 RGB Ring](https://www.amazon.ca/gp/product/B0774JNSCF/ref=ppx_yo_dt_b_search_asin_title?ie=UTF8&psc=1) +- [BN-220 GPS ](https://www.amazon.com/Navigation-Raspberry-Betaflight-Geekstory-Shipping/dp/B07PRDY6DS?th=1) +- [LSM303AGR Accelerometer + Compass](https://learn.adafruit.com/lsm303-accelerometer-slash-compass-breakout/overview) + +## Building + +### Main Project + +**To be added** + +### Tests + +*Requirements:* +- CppUTest 3.X +- Bash shell + +```sh +echo "1" | ./otto.sh +``` +The above command runs the automation script `otto.sh` that automates the +process of running tests for the project. + + +### Documentation + +*Requirements:* +- Doxygen +- Terminal/Shell + +The project's documentation is generated through documentation comments +that are held within the source files. You can use the command below to +generate the documentation from terminal. + +```sh +doxygen ./Doxyfile +``` + + +## Project Directory Overview + +Below you can find a list of the root directory. The project contains the +source files for arduino as well as the needed files for unit testing in +the future. + +```sh +tree -L 1 +. +├── build +├── CMakeLists.txt +├── compile_commands.json -> ./build/compile_commands.json +├── docs +├── Doxyfile +├── inc +├── LINX_SOFTWARE-COMMENTED.ino +├── mocks +├── otto.sh +├── README.md +├── setup.sh +├── src +└── tests + +6 directories, 7 files +```