Skip to content

Commit 0dcb6f3

Browse files
committed
feat(docs): update
1 parent 26a2fe7 commit 0dcb6f3

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,21 @@ To use the SDKs from this repository in the Arduino IDE, follow these steps:
5353
2. Ensure that the version of arduino-esp32 matches the version of the released SDKs in this repository.
5454
3. If yes, download the released SDKs from this repository and replace the corresponding libraries in the arduino-esp32 SDK:
5555
* Step 1: Find the default root path of the arduino-esp32 SDK. It should be different for different operating systems:
56-
* For Windows, the default path is `C:\Users\<user name>\AppData\Local\Arduino15\packages\esp32`.
57-
* For Linux, the default path is `~/.arduino15/packages/esp32`.
56+
* For **Windows**, the default path is `C:\Users\<user name>\AppData\Local\Arduino15\packages\esp32`.
57+
* For **Linux**, the default path is `~/.arduino15/packages/esp32`.
58+
* For **MacOS**, the default path is `~/Library/Arduino15/packages/esp32`.
5859
* Step 2: Find the default path of the SDK libraries. It should be different for different versions of arduino-esp32:
5960
* For arduino-esp32 `v2.x.x`, the default path is `hardware > esp32 > 2.x.x > tools > sdk`.
6061
* For arduino-esp32 `v3.x.x`, the default path is `tools > esp32-arduino-libs > idf-release_x`.
62+
* Step 3: The structure of the SDK libraries should be as follows, replace them with the libraries extracted from the downloaded SDK:
63+
```
64+
idf-release_x
65+
├── esp32
66+
├── esp32c3
67+
├── esp32c6
68+
├── ...
69+
├── packages.json
70+
├── tools.json
71+
├── versions.txt
72+
```
6173
4. If not, open an issue in this repository to request a new release or refer to the [documentation](https://docs.espressif.com/projects/arduino-esp32/en/latest/lib_builder.html) for compilation instructions.

0 commit comments

Comments
 (0)