mirror of
https://github.com/lvgl/lvgl.git
synced 2024-11-30 13:14:37 +08:00
docs: rearrange the get-started section
Add folder for Platforms, RTOS, and Bindings
This commit is contained in:
parent
4341660b93
commit
8a81532191
8
docs/get-started/binding/cpp.md
Normal file
8
docs/get-started/binding/cpp.md
Normal file
@ -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
|
||||
|
16
docs/get-started/binding/index.md
Normal file
16
docs/get-started/binding/index.md
Normal file
@ -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
|
||||
.. include:: /header.rst
|
||||
:github_url: |github_link_base|/get-started/micropython.md
|
||||
:github_url: |github_link_base|/get-started/bindings/micropython.md
|
||||
```
|
||||
# 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)
|
||||
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)
|
||||
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)
|
||||
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=)
|
||||
@ -23,16 +23,8 @@ There are several ways to get your feet wet with LVGL. Here is one recommended o
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
quick-overview
|
||||
pc-simulator
|
||||
stm32
|
||||
nxp
|
||||
espressif
|
||||
arduino
|
||||
micropython
|
||||
tasmota-berry
|
||||
nuttx
|
||||
rt-thread
|
||||
cmake
|
||||
platforms/index
|
||||
os/index
|
||||
bindings/index
|
||||
```
|
||||
|
||||
|
7
docs/get-started/os/freertos.md
Normal file
7
docs/get-started/os/freertos.md
Normal file
@ -0,0 +1,7 @@
|
||||
```eval_rst
|
||||
.. include:: /header.rst
|
||||
:github_url: |github_link_base|/get-started/os/freertos.md
|
||||
```
|
||||
# FreeRTOS
|
||||
|
||||
TODO
|
17
docs/get-started/os/index.md
Normal file
17
docs/get-started/os/index.md
Normal file
@ -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
|
||||
.. include:: /header.rst
|
||||
:github_url: |github_link_base|/get-started/nuttx.md
|
||||
:github_url: |github_link_base|/get-started/os/nuttx.md
|
||||
```
|
||||
# NuttX RTOS
|
||||
|
@ -1,6 +1,6 @@
|
||||
```eval_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
|
||||
|
7
docs/get-started/os/zephyr.md
Normal file
7
docs/get-started/os/zephyr.md
Normal file
@ -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
|
||||
.. include:: /header.rst
|
||||
:github_url: |github_link_base|/get-started/arduino.md
|
||||
:github_url: |github_link_base|/get-started/platforms/arduino.md
|
||||
```
|
||||
|
||||
# Arduino
|
@ -1,6 +1,6 @@
|
||||
```eval_rst
|
||||
.. include:: /header.rst
|
||||
:github_url: |github_link_base|/get-started/cmake.md
|
||||
:github_url: |github_link_base|/get-started/platforms/cmake.md
|
||||
```
|
||||
|
||||
# CMake
|
@ -1,6 +1,6 @@
|
||||
```eval_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)
|
20
docs/get-started/platforms/index.md
Normal file
20
docs/get-started/platforms/index.md
Normal file
@ -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
|
||||
.. include:: /header.rst
|
||||
:github_url: |github_link_base|/get-started/nxp.md
|
||||
:github_url: |github_link_base|/get-started/platforms/nxp.md
|
||||
```
|
||||
# NXP
|
||||
NXP has integrated LVGL into the MCUXpresso SDK packages for several of their general
|
@ -1,6 +1,6 @@
|
||||
```eval_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
|
||||
|
8
docs/get-started/platforms/stm32.md
Normal file
8
docs/get-started/platforms/stm32.md
Normal file
@ -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
|
||||
.. 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
|
||||
|
@ -1,8 +0,0 @@
|
||||
```eval_rst
|
||||
.. include:: /header.rst
|
||||
:github_url: |github_link_base|/get-started/stm32.md
|
||||
```
|
||||
|
||||
# STM32
|
||||
|
||||
TODO
|
Loading…
Reference in New Issue
Block a user