Skip to content

Commit

Permalink
feat: 📝 Improves gRPC docs by requiring Unix (#171)
Browse files Browse the repository at this point in the history
  • Loading branch information
BlakeFreer authored Sep 5, 2024
1 parent 3580788 commit b3d6e13
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/docs/firmware/dev-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,16 +144,16 @@ __Important:__ Create an empty file named `.clangd` in the `firmware/` directory

### gRPC

> This section should be improved. See [Issue 147](https://github.com/macformula/racecar/issues/147).
!!! warning "Optional Dependency"

gRPC c++ dependencies - [link](https://grpc.io/docs/languages/cpp/quickstart/)
Within the racecar repo, gRPC is only used by the SIL Client under `firmware/validation/sil/`. The client is used by the Raspberry Pi MCAL to interact with the [HIL / SIL](https://github.com/macformula/hil).

Follow the guide to build the example project.
You only need gRPC if you will be working on the HIL. Otherwise, do not worry about installing it.

Add the `CMAKE_PREFIX_PATH` environment variable to your machine
You will need a Unix development environment (Unix machine, WSL, or remote into the Raspberry Pi).

Go through the [gRPC C++ Quickstart Guide](https://grpc.io/docs/languages/cpp/quickstart/). Build the example project.

export CMAKE_PREFIX_PATH="$HOME/.local"

## IDE Setup

_If you use a different IDE, consider [adding instructions](../tutorials/site-dev.md) for setting it up!_
Expand Down

0 comments on commit b3d6e13

Please sign in to comment.