Skip to content

Commit e59355d

Browse files
lbernstoneme-no-dev
authored andcommitted
Docs for lib builder (#3415)
* Docs for lib builder * Typos and such
1 parent ec63d09 commit e59355d

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

Diff for: docs/esp-idf_component.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
To use as a component of ESP-IDF
22
=================================================
33

4+
## esp32-arduino-lib-builder
5+
6+
For a simplified method, see [lib-builder](lib_builder.md)
7+
48
## Installation
59

610
- Download and install [esp-idf](https://github.com/espressif/esp-idf)

Diff for: docs/lib_builder.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## Using esp32-arduino-lib-builder to compile custom libraries
2+
3+
Espressif has provided a [tool](https://github.com/espressif/esp32-arduino-lib-builder) to simplify building your own compiled libraries for use in Arduino IDE (or your favorite IDE).
4+
To use it to generate custom libraries, follow these steps:
5+
1. `git clone https://github.com/espressif/esp32-arduino-lib-builder`
6+
2. `cd esp32-arduino-lib-builder`
7+
3. `./tools/update-components.sh`
8+
4. `./tools/install-esp-idf.sh` (if you already have an $IDF_PATH defined, it will use your local copy of the repository)
9+
5. `make menuconfig` or directly edit sdkconfig.
10+
6. `./build.sh`
11+
12+
The script automates the process of building [arduino as an ESP-IDF component](https://github.com/espressif/arduino-esp32/blob/master/docs/esp-idf_component.md).
13+
Once it is complete, you can cherry pick the needed libraries from `out/tools/sdk/lib`, or run `tools/copy-to-arduino.sh` to copy the entire built system.
14+
`tools/config.sh` contains a number of variables that control the process, particularly the $IDF_BRANCH variable. You can adjust this to try building against newer versions, but there are absolutely no guarantees that any components will work or even successfully compile against a newer IDF.

0 commit comments

Comments
 (0)