Merge pull request lvgl#248 from lvgl/kisvegabor-patch-1

Minor updates in the README

Author: C47D

README.md

@@ -1,28 +1,26 @@
 # LVGL project for ESP32
 
 This is an ESP32 demo project showcasing LVGL v7 with support for several display controllers and touch controllers.
-The demo application is the demo_widgets project from the [lv_examples](https://github.com/lvgl/lv_examples) repository.
+The demo application is the `lv_demo_widgets` project from the [lv_examples](https://github.com/lvgl/lv_examples) repository.
 
-Version of LVGL used: 7.9.
-Version of lv_examples used: 7.9.
+- Version of LVGL used: 7.9.
+- Version of lv_examples used: 7.9.
 
-Notes:
-
-[Use LVGL in your ESP-IDF project](#Use-LVGL-in-your-ESP-IDF-project)
-
-[Use lvgl_esp32_drivers in your project](#Use-lvgl_esp32_drivers-in-your-project)
-
-[Platformio support](#Platformio-support)
+#### Table of content
+- [Get started](#get-started)
+- [Use LVGL in your ESP-IDF project](#use-lvgl-in-your-esp-idf-project)
+- [Use lvgl_esp32_drivers in your project](#use-lvgl_esp32_drivers-in-your-project)
+- [Platformio support](#platformio-support)
 
 Example demo for TFT displays:
 
-![Example GUI_DEMO](images/new_photo.jpg)
+![Example GUI_DEMO with ESP32 using LVGL](images/new_photo.jpg)
 
 Monochrome support:
 
-![Example_mono](images/new_mono.jpg)
+![Example_monochrome demo with ESP32 using LVGL](images/new_mono.jpg)
 
-# Display and touch controllers
+## Display and touch controllers
 
 The display and touch (indev) controllers are now into it's own repository, you can find it [here](https://github.com/lvgl/lvgl_esp32_drivers).
 To report any issue or add new display or touch (indev) drivers you can do so in the `lvgl_esp32_drivers` repo.
@@ -36,13 +34,13 @@ To report any issue or add new display or touch (indev) drivers you can do so in
 ### Note
 
 This project tries to be compatible with both the ESP-IDF v3.x and v4.0, but using v4.0 is recommended.
-Instructions assume you are using the v4.x toolchain, otherwise use the make commands, eg instead of running `idf.py menuconfig`, run `make menuconfig`.
+Instructions assume you are using the v4.x toolchain, otherwise use the make commands, e.g. instead of running `idf.py menuconfig`, run `make menuconfig`.
 
 ### Build and run the demo.
 
 1. Clone this project by `git clone --recurse-submodules https://github.com/lvgl/lv_port_esp32.git`, this will pull this repo and its submodules.
 
-2. Get into the `lv_port_esp32` directory created.
+2. Get into the created `lv_port_esp32` directory.
 
 3. Run `idf.py menuconfig`
 
@@ -54,26 +52,24 @@ Instructions assume you are using the v4.x toolchain, otherwise use the make com
 
 7. Build the project with `idf.py build`
 
-8. If the build don't throw any errors, flash the demo with `idf.py -p (YOUR SERIAL PORT) flash` (with make this is just `make flash` - in 3.x PORT is configured in `menuconfig`)
+8. If the build don't throw any errors, flash the demo with `idf.py -p (YOUR SERIAL PORT) flash` (with `make` this is just `make flash` - in 3.x PORT is configured in `menuconfig`)
 
 ## Use LVGL in your ESP-IDF project
 
 LVGL now includes a Kconfig file which is used to configure most of the LVGL configuration options via menuconfig, so it's not necessary to use a custom `lv_conf.h` file.
 
 It is recommended to add LVGL as a submodule in your IDF project's git repo.
 
-From your project root directory:
-
+From your project's root directory:
 1. Create a directory named `components` (if you don't have one already) with `mkdir -p components`.
 2. Clone the lvgl repository inside the `components` directory with `git submodule add https://github.com/lvgl/lvgl.git components/lvgl`
 3. Run `idf.py menuconfig`, go to `Component config` then `LVGL configuration` to configure LVGL.
 
 ## Use lvgl_esp32_drivers in your project
 
-It is recommended to add lvgl_esp32_drivers as a submodule in your IDF project's git repo.
-
-From your project root directory:
+It is recommended to add [lvgl_esp32_drivers](https://github.com/lvgl/lvgl_esp32_drivers) as a submodule in your IDF project's git repo.
 
+From your project's root directory:
 1. Create a directory named `components` (if you don't have one already) with `mkdir -p components`.
 2. Clone the lvgl_esp32_drivers repository inside the `components` directory with `git submodule add https://github.com/lvgl/lvgl_esp32_drivers.git components/lvgl_esp32_drivers`
 3. Run `idf.py menuconfig`, go to `Component config` then `LVGL TFT configuration` and `LVGL TFT Display configuration` to configure lvgl_esp32_drivers.