From 06309bbad33b01c7baae3006d2e37e0ec04e6653 Mon Sep 17 00:00:00 2001 From: n-speed Date: Tue, 10 Sep 2024 22:40:00 -0500 Subject: [PATCH 1/2] Updating the README.md to help out non-embedded members or people who just outright forgor --- README.md | 44 +++++++++++++++++++++++++++++++++++++++----- 1 file changed, 39 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index bc34c4e6..eece394e 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,47 @@ -
- # Texas Aimbots Embedded Development -
+The comprehensive controls library for Texas A&M Robomaster Robotics; the premier robotics organization of Texas A&M University! This repository is based on the [Taproot](https://gitlab.com/aruw/controls/taproot) framework and falls under the GPL-3.0 License + +## System Setup + +### Toolchain/Library Installation + +All setup guides are covered by the Taproot wiki. Select the guide appropriate for the platform you are using. + +**Note**: You will not be able to download the ST-Link driver. For TAMU RM members, you need to download Ozone and the respective J-Link drivers. We use exclusively J-Link's for live debugging and flashing of code to our main control boards. + +- Debian/Ubuntu: +- macOS: +- Windows: + +After installing all the required toolchains listed in the above guides as well as updating PATH variables, you will clone this repository. You can do this through VSCode, or by running: + +`git clone https://github.com/TAMU-Robomasters/aimbots-dev.git` + +Be sure you clone the repository into a sensible place on your computer (ie. not Downloads or in your OneDrive) + +### `pipenv` installation + +Pipenv is a Python tool that creates a virtual environment as well as manages packages. We will use this to run build tasks in an isolated environment. + +Run: + +```bash + +pip3 install pipenv +cd path/to/head/of/project +pipenv install + +``` + +This will install all necessary python packages that will assist in building code +## Building Code -# Setup +In order to build a firmware/code image for a main control board/dev board, first `cd` to the head of `aimbots-src`. Your file path will look something similar to `~/path/to/repo/aimbots-dev/aimbots-src` -Everything is detailed in the `documentation/setup.md`! +Next, run +`pipenv run scons build robot=[TARGET_HERE]`. A list of valid targets is located in `extract_robot_type.py` From 623304b8f19ebceb1eab80fb043805ca04c2734b Mon Sep 17 00:00:00 2001 From: Nathaniel Speed Date: Thu, 3 Oct 2024 15:04:25 -0500 Subject: [PATCH 2/2] Updated README.md --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index eece394e..23405811 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,11 @@ The comprehensive controls library for Texas A&M Robomaster Robotics; the premie ### Toolchain/Library Installation -All setup guides are covered by the Taproot wiki. Select the guide appropriate for the platform you are using. +Setup is derived from the following guides within the Taproot wiki. Select the guide appropriate for the platform you are using. -**Note**: You will not be able to download the ST-Link driver. For TAMU RM members, you need to download Ozone and the respective J-Link drivers. We use exclusively J-Link's for live debugging and flashing of code to our main control boards. +**Note**: ***You will not be able to download the ST-Link driver***. For TAMU RM members, you need to download Ozone and the respective J-Link drivers. We use exclusively J-Link's for live debugging and flashing of code to our main control boards. + +**Second Note** You will not be able to install ClangFormat Version 10. This will be fixed in the future but your code should still be able to compile without issue - Debian/Ubuntu: - macOS: @@ -19,7 +21,7 @@ All setup guides are covered by the Taproot wiki. Select the guide appropriate f After installing all the required toolchains listed in the above guides as well as updating PATH variables, you will clone this repository. You can do this through VSCode, or by running: -`git clone https://github.com/TAMU-Robomasters/aimbots-dev.git` +`git clone https://github.com/TAMU-Robomasters/aimbots-dev` Be sure you clone the repository into a sensible place on your computer (ie. not Downloads or in your OneDrive) @@ -30,11 +32,9 @@ Pipenv is a Python tool that creates a virtual environment as well as manages pa Run: ```bash - pip3 install pipenv -cd path/to/head/of/project +cd path/to/repo/aimbots-dev pipenv install - ``` This will install all necessary python packages that will assist in building code