Skip to content

Commit bc63c01

Browse files
authored
Update README.md
1 parent 36b836c commit bc63c01

File tree

1 file changed

+13
-15
lines changed

1 file changed

+13
-15
lines changed

README.md

+13-15
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22

33
This repository contains the scripts that produce the libraries included with Tasmota esp32-arduino.
44

5+
Tested on Ubuntu and MacOS.
6+
57
### Build on Ubuntu
68
```bash
7-
sudo apt update && sudo apt install -y git wget curl libssl-dev libncurses-dev flex bison gperf python3 cmake ninja-build ccache jq
8-
curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py && python3 get-pip.py && \
9-
pip3 install setuptools pyserial click future wheel cryptography pyparsing pyelftools
10-
git clone https://github.com/Jason2866/esp32-arduino-lib-builder
9+
sudo apt-get install git wget curl libssl-dev libncurses-dev flex bison gperf python python-pip python-setuptools python-serial python-click python-cryptography python-future python-pyparsing python-pyelftools cmake ninja-build ccache jq
10+
sudo pip install --upgrade pip
11+
git clone https://github.com/espressif/esp32-arduino-lib-builder
1112
cd esp32-arduino-lib-builder
1213
./build.sh
1314
```
1415

15-
1616
### Using the User Interface
1717

1818
You can more easily build the libraries using the user interface found in the `tools/config_editor/` folder.
@@ -22,25 +22,23 @@ For more information and troubleshooting, please refer to the [UI README](tools/
2222

2323
To use it, follow these steps:
2424

25-
1. Make sure you have the required dependencies installed:
25+
1. Make sure you have the following prerequisites:
2626
- Python 3.9 or later
27-
- The [Textual](https://github.com/textualize/textual/) library
2827
- All the dependencies listed in the previous section
2928

30-
2. Execute the script `tools/config_editor/app.py` from any folder. It will automatically detect the path to the root of the repository.
29+
2. Install the required UI packages using `pip install -r tools/config_editor/requirements.txt`.
3130

32-
3. Configure the compilation and ESP-IDF options as desired.
31+
3. Execute the script `tools/config_editor/app.py` from any folder. It will automatically detect the path to the root of the repository.
3332

34-
4. Click on the "Compile Static Libraries" button to start the compilation process.
33+
4. Configure the compilation and ESP-IDF options as desired.
3534

36-
5. The script will show the compilation output in a new screen. Note that the compilation process can take many hours, depending on the number of libraries selected and the options chosen.
35+
5. Click on the "Compile Static Libraries" button to start the compilation process.
3736

38-
6. If the compilation is successful you can find the Platformio framework in the `dist` folder alongside this repository.
37+
6. The script will show the compilation output in a new screen. Note that the compilation process can take many hours, depending on the number of libraries selected and the options chosen.
3938

39+
7. If the compilation is successful and the option to copy the libraries to the Arduino Core folder is enabled, it will already be available for use in the Arduino IDE. Otherwise, you can find the compiled libraries in the `esp32-arduino-libs` folder alongside this repository.
40+
- Note that the copy operation doesn't currently support the core downloaded from the Arduino IDE Boards Manager, only the manual installation from the [`arduino-esp32`](https://github.com/espressif/arduino-esp32) repository.
4041

4142
### Documentation
4243

4344
For more information about how to use the Library builder, please refer to this [Documentation page](https://docs.espressif.com/projects/arduino-esp32/en/latest/lib_builder.html?highlight=lib%20builder)
44-
45-
### Development builds
46-
Look in release and download a version. There is the Info of the used commits of IDF / Arduino.

0 commit comments

Comments
 (0)