mirror of
https://github.com/lvgl/lvgl.git
synced 2026-06-06 00:54:24 +08:00
docs: rearrange the get-started section
Add folder for Platforms, RTOS, and Bindings
This commit is contained in:
@@ -0,0 +1,8 @@
|
|||||||
|
```eval_rst
|
||||||
|
.. include:: /header.rst
|
||||||
|
:github_url: |github_link_base|/get-started/bindings/micropython.md
|
||||||
|
```
|
||||||
|
#Cpp
|
||||||
|
|
||||||
|
In progress: https://github.com/lvgl/lv_binding_cpp
|
||||||
|
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
```eval_rst
|
||||||
|
.. include:: /header.rst
|
||||||
|
:github_url: |github_link_base|/get-started/bindings/index.md
|
||||||
|
```
|
||||||
|
# Bindings
|
||||||
|
|
||||||
|
|
||||||
|
```eval_rst
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
micropython
|
||||||
|
cpp
|
||||||
|
```
|
||||||
|
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
```eval_rst
|
```eval_rst
|
||||||
.. include:: /header.rst
|
.. include:: /header.rst
|
||||||
:github_url: |github_link_base|/get-started/micropython.md
|
:github_url: |github_link_base|/get-started/bindings/micropython.md
|
||||||
```
|
```
|
||||||
# Micropython
|
# Micropython
|
||||||
|
|
||||||
@@ -8,7 +8,7 @@ There are several ways to get your feet wet with LVGL. Here is one recommended o
|
|||||||
1. Check the [Online demos](https://lvgl.io/demos) to see LVGL in action (3 minutes)
|
1. Check the [Online demos](https://lvgl.io/demos) to see LVGL in action (3 minutes)
|
||||||
2. Read the [Introduction](https://docs.lvgl.io/latest/en/html/intro/index.html) page of the documentation (5 minutes)
|
2. Read the [Introduction](https://docs.lvgl.io/latest/en/html/intro/index.html) page of the documentation (5 minutes)
|
||||||
3. Read the [Quick overview](https://docs.lvgl.io/master/get-started/quick-overview.html) page of the documentation (15 minutes)
|
3. Read the [Quick overview](https://docs.lvgl.io/master/get-started/quick-overview.html) page of the documentation (15 minutes)
|
||||||
4. Set up a [Simulator](https://docs.lvgl.io/master/get-started/pc-simulator.html) (10 minutes)
|
4. Set up a [Simulator](https://docs.lvgl.io/master/get-started/platforms/pc-simulator.html) (10 minutes)
|
||||||
5. Try out some [Examples](https://docs.lvgl.io/master/examples.html)
|
5. Try out some [Examples](https://docs.lvgl.io/master/examples.html)
|
||||||
6. Check out the Platform-specific tutorials. (in this section below). (10 minutes)
|
6. Check out the Platform-specific tutorials. (in this section below). (10 minutes)
|
||||||
7. Port LVGL to a board. See the [Porting](https://docs.lvgl.io/master/porting/index.html) guide or check the ready to use [Projects](https://github.com/lvgl?q=lv_port_&type=&language=)
|
7. Port LVGL to a board. See the [Porting](https://docs.lvgl.io/master/porting/index.html) guide or check the ready to use [Projects](https://github.com/lvgl?q=lv_port_&type=&language=)
|
||||||
@@ -23,16 +23,8 @@ There are several ways to get your feet wet with LVGL. Here is one recommended o
|
|||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
quick-overview
|
platforms/index
|
||||||
pc-simulator
|
os/index
|
||||||
stm32
|
bindings/index
|
||||||
nxp
|
|
||||||
espressif
|
|
||||||
arduino
|
|
||||||
micropython
|
|
||||||
tasmota-berry
|
|
||||||
nuttx
|
|
||||||
rt-thread
|
|
||||||
cmake
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,7 @@
|
|||||||
|
```eval_rst
|
||||||
|
.. include:: /header.rst
|
||||||
|
:github_url: |github_link_base|/get-started/os/freertos.md
|
||||||
|
```
|
||||||
|
# FreeRTOS
|
||||||
|
|
||||||
|
TODO
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
```eval_rst
|
||||||
|
.. include:: /header.rst
|
||||||
|
:github_url: |github_link_base|/get-started/os/index.md
|
||||||
|
```
|
||||||
|
# (RT)OS
|
||||||
|
|
||||||
|
```eval_rst
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
nuttx
|
||||||
|
rt-thread
|
||||||
|
freertos
|
||||||
|
zephyr
|
||||||
|
```
|
||||||
|
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
```eval_rst
|
```eval_rst
|
||||||
.. include:: /header.rst
|
.. include:: /header.rst
|
||||||
:github_url: |github_link_base|/get-started/nuttx.md
|
:github_url: |github_link_base|/get-started/os/nuttx.md
|
||||||
```
|
```
|
||||||
# NuttX RTOS
|
# NuttX RTOS
|
||||||
|
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
```eval_rst
|
```eval_rst
|
||||||
.. include:: /header.rst
|
.. include:: /header.rst
|
||||||
:github_url: |github_link_base|/get-started/rt-thread.md
|
:github_url: |github_link_base|/get-started/os/rt-thread.md
|
||||||
```
|
```
|
||||||
# RT-Thread RTOS
|
# RT-Thread RTOS
|
||||||
|
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
```eval_rst
|
||||||
|
.. include:: /header.rst
|
||||||
|
:github_url: |github_link_base|/get-started/os/zephyr.md
|
||||||
|
```
|
||||||
|
# FreeRTOS
|
||||||
|
|
||||||
|
TODO
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
```eval_rst
|
```eval_rst
|
||||||
.. include:: /header.rst
|
.. include:: /header.rst
|
||||||
:github_url: |github_link_base|/get-started/arduino.md
|
:github_url: |github_link_base|/get-started/platforms/arduino.md
|
||||||
```
|
```
|
||||||
|
|
||||||
# Arduino
|
# Arduino
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
```eval_rst
|
```eval_rst
|
||||||
.. include:: /header.rst
|
.. include:: /header.rst
|
||||||
:github_url: |github_link_base|/get-started/cmake.md
|
:github_url: |github_link_base|/get-started/platforms/cmake.md
|
||||||
```
|
```
|
||||||
|
|
||||||
# CMake
|
# CMake
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
```eval_rst
|
```eval_rst
|
||||||
.. include:: /header.rst
|
.. include:: /header.rst
|
||||||
:github_url: |github_link_base|/get-started/espressif.md
|
:github_url: |github_link_base|/get-started/platforms/espressif.md
|
||||||
```
|
```
|
||||||
|
|
||||||
# Espressif (ESP32 chip series)
|
# Espressif (ESP32 chip series)
|
||||||
@@ -0,0 +1,20 @@
|
|||||||
|
```eval_rst
|
||||||
|
.. include:: /header.rst
|
||||||
|
:github_url: |github_link_base|/get-started/index.md
|
||||||
|
```
|
||||||
|
# Platforms
|
||||||
|
|
||||||
|
```eval_rst
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
pc-simulator
|
||||||
|
stm32
|
||||||
|
nxp
|
||||||
|
espressif
|
||||||
|
arduino
|
||||||
|
tasmota-berry
|
||||||
|
cmake
|
||||||
|
```
|
||||||
|
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
```eval_rst
|
```eval_rst
|
||||||
.. include:: /header.rst
|
.. include:: /header.rst
|
||||||
:github_url: |github_link_base|/get-started/nxp.md
|
:github_url: |github_link_base|/get-started/platforms/nxp.md
|
||||||
```
|
```
|
||||||
# NXP
|
# NXP
|
||||||
NXP has integrated LVGL into the MCUXpresso SDK packages for several of their general
|
NXP has integrated LVGL into the MCUXpresso SDK packages for several of their general
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
```eval_rst
|
```eval_rst
|
||||||
.. include:: /header.rst
|
.. include:: /header.rst
|
||||||
:github_url: |github_link_base|/get-started/pc-simulator.md
|
:github_url: |github_link_base|/get-started/platoforms/simulator.md
|
||||||
```
|
```
|
||||||
# Simulator on PC
|
# Simulator on PC
|
||||||
|
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
```eval_rst
|
||||||
|
.. include:: /header.rst
|
||||||
|
:github_url: |github_link_base|/get-started/platforms/stm32.md
|
||||||
|
```
|
||||||
|
|
||||||
|
# STM32
|
||||||
|
|
||||||
|
TODO
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
```eval_rst
|
```eval_rst
|
||||||
.. include:: /header.rst
|
.. include:: /header.rst
|
||||||
:github_url: |github_link_base|/get-started/tasmota-berry.md
|
:github_url: |github_link_base|/get-started/platforms/tasmota-berry.md
|
||||||
```
|
```
|
||||||
# Tasmota and berry
|
# Tasmota and berry
|
||||||
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
```eval_rst
|
|
||||||
.. include:: /header.rst
|
|
||||||
:github_url: |github_link_base|/get-started/stm32.md
|
|
||||||
```
|
|
||||||
|
|
||||||
# STM32
|
|
||||||
|
|
||||||
TODO
|
|
||||||
Reference in New Issue
Block a user