From c370707de043e16575eebea754698e59c57d1784 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Vladi=C4=87?= Date: Mon, 21 Nov 2022 13:06:20 +0100 Subject: [PATCH] Update README.md --- README.md | 80 +++++++++++++++++++++++++------------------------------ 1 file changed, 36 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index 5ea019e..a247364 100644 --- a/README.md +++ b/README.md @@ -12,66 +12,58 @@ https://github.com/eez-open/studio ### Using this repo -If you do not have ESP IDF check here how to install (you can use v4.4.3): +1) If you do not have ESP IDF check here how to install (you can use v4.4.3): -https://docs.espressif.com/projects/esp-idf/en/v4.4.3/esp32/get-started/index.html + https://docs.espressif.com/projects/esp-idf/en/v4.4.3/esp32/get-started/index.html -Go inside you ESP IDF instalation folder and run: + Go inside you ESP IDF instalation folder and run: -``` -. export.sh -``` - -Now, go to the folder where you want this project to be and clone this repo: - -``` -git clone --recurse-submodules https://github.com/goran-mahovlic/esp32-lvgl-eez-demo.git -``` + ``` + . export.sh + ``` -Go to the newly created folder: +2) Now, go to the folder where you want this project to be and clone this repo: -``` -cd esp32-lvgl-eez-demo -``` - -Copy CMakeLists to CalEPD folder: - -``` -cp configs/CalEPD_CMakeLists.txt components/CalEPD/CMakeLists.txt -``` + ``` + git clone --recurse-submodules https://github.com/goran-mahovlic/esp32-lvgl-eez-demo.git + ``` -or you can yust run prepare.sh: +3) Go to the newly created folder: -``` -chmod +x prepare.sh -./prepare.sh -``` + ``` + cd esp32-lvgl-eez-demo + ``` -Select example project according to your display board. For example, if you have Inkplate6, execute following: +4) Build example project according to your display board. For example, if you have Inkplate6, execute following: -``` -./examples/Inkplate6/use.sh -``` + ``` + ./build.sh Inkplate6 + ``` -Make sure your inkplate board is connected and powered on and start IDF build and flash: +5) Make sure your Inkplate6 board is connected and powered, then start flash: -``` -idf.py build; idf.py -p /dev/ttyUSB0 flash monitor -``` + ``` + idf.py -p /dev/ttyUSB0 flash monitor + ``` -If you want to try some other display board then, again, first select example for that board, for example for ILI9341: +- **Note 1** These are build commands for other display boards: -``` -./examples/ILI9341_240x320/use.sh -``` + ``` + ./build.sh Heltec + ./build.sh ILI9341_240x320 + ./build.sh TouchDown + + etc. + + ``` -and then start IDF: +- **Note 2** You must execute fullbuild.sh when you switch between display boards: -``` -make clean; idf.py fullclean -``` + ``` + ./fullbuild.sh Inkplate6 + ``` -To make changes in the GUI, you can open eez-project file, i.e. `examples/Inkplate6/esp32-lvgl-eez-demo-Inkplate6.eez-project` in [EEZ Studio](https://github.com/eez-open/studio). When you are done editing changes, first build within EEZ Studio and then build with IDF. +- **Note 3** To make changes in the GUI, you can open eez-project file, i.e. `examples/Inkplate6/esp32-lvgl-eez-demo-Inkplate6.eez-project` in [EEZ Studio](https://github.com/eez-open/studio). When you are done editing changes, first build within Studio and then use `./build Inkplate6` again. ### Example EEZ GUI with ESP32 using LVGL