From 0c6606817e1907f0c451e1f1ff42b14c95fd0d3f Mon Sep 17 00:00:00 2001 From: Blake Freer <59676067+BlakeFreer@users.noreply.github.com> Date: Fri, 25 Oct 2024 23:09:16 -0400 Subject: [PATCH] Add BMS abbreviation and fix a typo (#243) --- docs/docs/firmware/dev-setup.md | 2 +- docs/includes/abbreviations.md | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/docs/firmware/dev-setup.md b/docs/docs/firmware/dev-setup.md index ee8c9e627..745a55b69 100644 --- a/docs/docs/firmware/dev-setup.md +++ b/docs/docs/firmware/dev-setup.md @@ -176,7 +176,7 @@ With the environment activated, change into `racecar/` and install CANgen: pip install -e scripts/cangen ``` -> The `-e` flag is _very_ important. It install CANgen as an editable package which means you won't have to reinstall when the package is changed. +> The `-e` flag is _very_ important. It installs CANgen as an editable package which means you won't have to reinstall when the package is changed. You can now start developing in `racecar`! However, I recommend you configure your IDE with `clangd`, so continue to the next section. diff --git a/docs/includes/abbreviations.md b/docs/includes/abbreviations.md index ddfd76b7a..2c83a6102 100644 --- a/docs/includes/abbreviations.md +++ b/docs/includes/abbreviations.md @@ -17,3 +17,4 @@ *[LV]: Low Voltage. The vehicle circuit that powers all non-motor electronics. Contrast with HV. *[HV]: High Voltage. The vehicle circuit which powers our motors. Contrast with LV. *[MCAL]: MicroController Abstraction Layer. +*[BMS]: Battery Management System. A vehicle device responsible for consistently and safely drawing power from the accumulator / battery.