summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorailurux <me@dbyron.id.au>2022-10-06 15:40:50 +1100
committerailurux <me@dbyron.id.au>2022-10-06 15:40:50 +1100
commitcd1c36c0e24d1734b84cf7bbc2666e082a835118 (patch)
tree0c3163c4be44c157325e617e04f00f5d851a439e /README.md
parentfa4c5bd6c213067223a193bd74a8584e0eafe1bc (diff)
downloadtangara-fw-cd1c36c0e24d1734b84cf7bbc2666e082a835118.tar.gz
Update readme for vscode
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/README.md b/README.md
index ff7b0c41..f14da8b3 100644
--- a/README.md
+++ b/README.md
@@ -18,8 +18,17 @@ to correctly set up your environment for building.
```
. ./.env
```
+**For VSCode:**
-3. You can now build the project using `idf.py build`. Or to flash the project
+When using the Espressif IDF extension, you may want to set the following in your settings.json file:
+```
+ "idf.espAdfPath": "${workspaceFolder}/lib/esp-adf",
+ "idf.espAdfPathWin": "${workspaceFolder}/lib/esp-adf",
+ "idf.espIdfPath": "${workspaceFolder}/lib/esp-adf/esp-idf",
+ "idf.espIdfPathWin": "${workspaceFolder}/lib/esp-adf/esp-idf"
+```
+
+4. You can now build the project using `idf.py build`. Or to flash the project
onto your board, something like:
```
idf.py -p /dev/ttyUSB0 -b 115200 flash