Skip to content

Commit 5de74c4

Browse files
committed
CONTRIBUTING: document GCC_10_ARM_NONE_EABI_BIN
This adds documentation for the GCC_10_ARM_NONE_EABI_BIN environment variable to CONTRIBUTING.md and expands the explanation in c_cpp_properties.json to cover Windows.
1 parent 842c69e commit 5de74c4

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

.vscode/c_cpp_properties.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,13 @@
1010
// export GCC_10_ARM_NONE_EABI_BIN=/path/to/gcc-10-arm-none-eabi/bin/
1111
//
1212
// in .bashrc or .zshrc (trailing slash is required), then restart VS Code.
13+
//
14+
// On Windows, you can set this environment variable to (trailing slash is required):
15+
//
16+
// C:\Program Files (x86)\GNU Arm Embedded Toolchain\10 2020-q4-major>code bin\
17+
//
18+
// via the System Properties. Restarting VS Code after this should be sufficient,
19+
// but you may need to log out and log back in if that doesn't work.
1320

1421
{
1522
"env": {

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,15 @@ working in the virtual environment. You should run `poetry shell` any time you
159159
open a new terminal window while working on `pybricks-micropython`.
160160

161161

162+
### Set up VS Code
163+
164+
When using the Microsoft C/C++ extension for VS Code, you will need to set the
165+
`GCC_10_ARM_NONE_EABI_BIN` environment variable to the directory where the Arm
166+
toolchain was installed so that it can find the compiler to assist with code
167+
analysis. See [.vscode/c_cpp_properties.json](.vscode/c_cpp_properties.json)
168+
for more info.
169+
170+
162171
Building the code
163172
-----------------
164173

0 commit comments

Comments
 (0)