8000 update component install doc · LeonMatthes/arduino-esp32@3461fef · GitHub
[go: up one dir, main page]

Skip to content

Commit 3461fef

Browse files
author
summivox
committed
update component install doc
1 parent 7c5a879 commit 3461fef

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

docs/esp-idf_component.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ To use as a component of ESP-IDF
33

44
## Installation
55

6-
- Download and install [esp-idf v4.2 release](https://github.com/espressif/esp-idf)
6+
- Download and install [esp-idf v4.2 release](https://github.com/espressif/arduino-esp32/tree/idf-release/v4.2)
77
- Create blank idf project (from one of the examples)
88
- in the project folder, create a folder called components and clone this repository inside
99

@@ -16,6 +16,13 @@ To use as a component of ESP-IDF
1616
cd ../.. && \
1717
make menuconfig
1818
```
19+
20+
**If the project is already in a git repo, use these instead:**
21+
22+
```bash
23+
mkdir -p components && \
24+
git submodule add https://github.com/summivox/arduino-esp32 arduino --branch mod-idf-v4.2 --recursive
25+
```
1926

2027
- ```make menuconfig``` has some Arduino options
2128
- **important: you MUST enable these to build**

0 commit comments

Comments
 (0)
0