From fcf833f9afd34b560d0550d72d12e3c61ef8cc66 Mon Sep 17 00:00:00 2001 From: Xiang Xiao Date: Mon, 21 Mar 2022 20:34:12 +0800 Subject: [PATCH] Minor document update (#3185) * chore(docs): change "-DLV_USE_BTN 1" to "-DLV_USE_BTN=1" Signed-off-by: Xiang Xiao * chore(docs): update demo related link and description Signed-off-by: Xiang Xiao --- docs/get-started/platforms/cmake.md | 12 +----------- docs/get-started/platforms/espressif.md | 2 +- docs/porting/display.md | 2 +- docs/porting/project.md | 2 +- 4 files changed, 4 insertions(+), 14 deletions(-) diff --git a/docs/get-started/platforms/cmake.md b/docs/get-started/platforms/cmake.md index 046212974..57b210e65 100644 --- a/docs/get-started/platforms/cmake.md +++ b/docs/get-started/platforms/cmake.md @@ -71,23 +71,13 @@ target_link_libraries(MyFirmware PRIVATE lvgl::lvgl lvgl::examples) ``` ## Building LVGL drivers and demos with CMake -Exactly the same goes for the [drivers](https://github.com/lvgl/lv_drivers) and the [demos](https://github.com/lvgl/lv_demos). +Exactly the same goes for the [drivers](https://github.com/lvgl/lv_drivers) and the [demos](https://github.com/lvgl/lvgl/demos). ```cmake -# Specify path to own LVGL demos config header -set(LV_DEMO_CONF_PATH - ${CMAKE_CURRENT_SOURCE_DIR}/src/lv_demo_conf.h - CACHE STRING "" FORCE) - FetchContent_Declare(lv_drivers GIT_REPOSITORY https://github.com/lvgl/lv_drivers) FetchContent_MakeAvailable(lv_drivers) -FetchContent_Declare(lv_demos - GIT_REPOSITORY https://github.com/lvgl/lv_demos.git) -FetchContent_MakeAvailable(lv_demos) # The target "MyFirmware" depends on LVGL, drivers and demos target_link_libraries(MyFirmware PRIVATE lvgl::lvgl lvgl::drivers lvgl::examples) ``` - -Just like the [lv_conf.h](https://github.com/lvgl/lvgl/blob/master/lv_conf_template.h) header demos comes with its own config header called [lv_demo_conf.h](https://github.com/lvgl/lv_demos/blob/master/lv_demo_conf_template.h). Analogous to `LV_CONF_PATH` its path can be set by using the option `LV_DEMO_CONF_PATH`. diff --git a/docs/get-started/platforms/espressif.md b/docs/get-started/platforms/espressif.md index 03428256c..45088159a 100644 --- a/docs/get-started/platforms/espressif.md +++ b/docs/get-started/platforms/espressif.md @@ -10,7 +10,7 @@ More information about ESP-IDF build system can be found [here](https://docs.esp ## LVGL demo project for ESP32 -We've created [lv_port_esp32](https://github.com/lvgl/lv_port_esp32), a project using ESP-IDF and LVGL to show one of the demos from [lv_demos](https://github.com/lvgl/lv_demos). +We've created [lv_port_esp32](https://github.com/lvgl/lv_port_esp32), a project using ESP-IDF and LVGL to show one of the demos from [demos](https://github.com/lvgl/lvgl/demos). You can configure the project to use one of the many supported display controllers and targets (chips). See [lvgl_esp32_drivers](https://github.com/lvgl/lvgl_esp32_drivers) repository for a complete list diff --git a/docs/porting/display.md b/docs/porting/display.md index 983e28d3d..719a2343c 100644 --- a/docs/porting/display.md +++ b/docs/porting/display.md @@ -38,7 +38,7 @@ Therefore it's recommended to choose the size of the draw buffer(s) to be at lea There are several settings to adjust the number draw buffers and buffering/refreshing modes. -You can measure the performance of different configurations using the [benchmark example](https://github.com/lvgl/lv_demos/tree/master/src/lv_demo_benchmark). +You can measure the performance of different configurations using the [benchmark example](https://github.com/lvgl/lvgl/tree/master/demos/benchmark). ### One buffer If only one buffer is used LVGL draws the content of the screen into that draw buffer and sends it to the display. diff --git a/docs/porting/project.md b/docs/porting/project.md index 7ce6b6a3f..ed5794a9d 100644 --- a/docs/porting/project.md +++ b/docs/porting/project.md @@ -54,7 +54,7 @@ In this case LVGL will attempt to include `lv_conf.h` simply with `#include "lv_ You can even use a different name for `lv_conf.h`. The custom path can be set via the `LV_CONF_PATH` define. For example `-DLV_CONF_PATH="/home/joe/my_project/my_custom_conf.h"` -If `LV_CONF_SKIP` is defined, LVGL will not try to include `lv_conf.h`. Instead you can pass the config defines using build options. For example `"-DLV_COLOR_DEPTH=32 -DLV_USE_BTN 1"`. The unset options will get a default value which is the same as the ones in `lv_conf_template.h`. +If `LV_CONF_SKIP` is defined, LVGL will not try to include `lv_conf.h`. Instead you can pass the config defines using build options. For example `"-DLV_COLOR_DEPTH=32 -DLV_USE_BTN=1"`. The unset options will get a default value which is the same as the ones in `lv_conf_template.h`. LVGL also can be used via `Kconfig` and `menuconfig`.  You can use `lv_conf.h` together with Kconfig, but keep in mind that the value from `lv_conf.h` or build settings (`-D...`) overwrite the values set in Kconfig. To ignore the configs from `lv_conf.h` simply remove its content, or define `LV_CONF_SKIP`.