Skip to content

Commit

Permalink
Add CANgen requirements to dev setup (#200)
Browse files Browse the repository at this point in the history
  • Loading branch information
BlakeFreer authored Oct 2, 2024
1 parent 62a0caf commit 375342a
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions docs/docs/firmware/dev-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,32 @@ Navigate to a directory where you would like to hold the `racecar` repo (I used
git clone --recurse-submodules https://github.com/macformula/racecar.git
## Install CANgen dependencies
Create a Python virtual environment for CANgen. Navigate into `racecar/firmware` and run.
=== "Windows"
```text
python -m venv .env
.env\Scripts\activate
```
=== "Linux / Mac"
```bash
python3 -m venv .env
source .env/bin/activate
```
The second command "activates" the virtual environment. You will see `(.env)` beside your terminal prompt when it is activated, and it must be activated before building any project.
Finally, with the environment activated, install the CANgen requirements.
```bash
pip install -r ../scripts/cangen/requirements.txt
```

You can now start developing in `racecar`! However, I recommend you configure your IDE with `clangd`, so continue to the next section.

## IDE Integration
Expand Down

0 comments on commit 375342a

Please sign in to comment.