Skip to content

Commit 38169b0

Browse files
committed
Added lib builder and esp-idf as component rst files
1 parent ce5afb3 commit 38169b0

File tree

3 files changed

+29
-1
lines changed

3 files changed

+29
-1
lines changed

docs/source/esp-idf_component.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
ESP-IDF as Component
2+
====================

docs/source/index.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Welcome to ESP32 Arduino Core's documentation
2-
================================================
2+
=============================================
33

44
.. toctree::
55
:maxdepth: 2
@@ -9,3 +9,5 @@ Welcome to ESP32 Arduino Core's documentation
99
Installing <installing>
1010
Boards <boards/boards>
1111
Libraries <libraries>
12+
Library Builder <lib_builder>
13+
ESP-IDF as Component <esp-idf_component>

docs/source/lib_builder.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
Library Builder
2+
===============
3+
4+
How to Use Library Builder
5+
**************************
6+
7+
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).
8+
To use it to generate custom libraries, follow these steps:
9+
10+
11+
- Ubuntu and Debian::
12+
13+
git clone https://github.com/espressif/esp32-arduino-lib-builder
14+
15+
#. Step 1. ``
16+
#. Step 2. `cd esp32-arduino-lib-builder`
17+
#. Step 3. `./tools/update-components.sh`
18+
#. Step 4. `./tools/install-esp-idf.sh` (if you already have an $IDF_PATH defined, it will use your local copy of the repository)
19+
#. Step 5. `make menuconfig` or directly edit sdkconfig.
20+
#. Step 6. `./build.sh`
21+
22+
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).
23+
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.
24+
`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)