diff options
| author | sakumisu <[email protected]> | 2024-09-08 00:17:55 +0800 |
|---|---|---|
| committer | sakumisu <[email protected]> | 2024-09-08 22:12:35 +0800 |
| commit | da391c6cf97ddf78be5bed323ce186b26b9c66c3 (patch) | |
| tree | 4a33ad840c7d8a69d1d12bbfdeb51f6f1152ce82 /docs/source/quick_start | |
| parent | b56b67182aff93a685aa77e9b5ea7f443a3d2c9d (diff) | |
docs: update rst framework
Diffstat (limited to 'docs/source/quick_start')
| -rw-r--r-- | docs/source/quick_start/demo.rst (renamed from docs/source/quick_start/index.rst) | 0 | ||||
| -rw-r--r-- | docs/source/quick_start/esp.rst | 17 | ||||
| -rw-r--r-- | docs/source/quick_start/img/env0.png (renamed from docs/source/quick_start/rt-thread/img/env0.png) | bin | 17041 -> 17041 bytes | |||
| -rw-r--r-- | docs/source/quick_start/img/env1.png (renamed from docs/source/quick_start/rt-thread/img/env1.png) | bin | 42859 -> 42859 bytes | |||
| -rw-r--r-- | docs/source/quick_start/img/env2.png (renamed from docs/source/quick_start/rt-thread/img/env2.png) | bin | 66915 -> 66915 bytes | |||
| -rw-r--r-- | docs/source/quick_start/img/esp1.png | bin | 0 -> 28939 bytes | |||
| -rw-r--r-- | docs/source/quick_start/img/esp2.png | bin | 0 -> 72318 bytes | |||
| -rw-r--r-- | docs/source/quick_start/img/esp3.png | bin | 0 -> 29745 bytes | |||
| -rw-r--r-- | docs/source/quick_start/img/esp4.png | bin | 0 -> 52878 bytes | |||
| -rw-r--r-- | docs/source/quick_start/img/stm32_init.png (renamed from docs/source/quick_start/rt-thread/img/stm32_init.png) | bin | 8280 -> 8280 bytes | |||
| -rw-r--r-- | docs/source/quick_start/img/stm32_init2.png (renamed from docs/source/quick_start/rt-thread/img/stm32_init2.png) | bin | 47691 -> 47691 bytes | |||
| -rw-r--r-- | docs/source/quick_start/img/stm32cubemx0.png (renamed from docs/source/quick_start/rt-thread/img/stm32cubemx0.png) | bin | 22591 -> 22591 bytes | |||
| -rw-r--r-- | docs/source/quick_start/img/stm32cubemx1.png (renamed from docs/source/quick_start/rt-thread/img/stm32cubemx1.png) | bin | 37705 -> 37705 bytes | |||
| -rw-r--r-- | docs/source/quick_start/img/stm32cubemx2.png (renamed from docs/source/quick_start/rt-thread/img/stm32cubemx2.png) | bin | 41977 -> 41977 bytes | |||
| -rw-r--r-- | docs/source/quick_start/img/stm32cubemx_clk.png (renamed from docs/source/quick_start/rt-thread/img/stm32cubemx_clk.png) | bin | 16418 -> 16418 bytes | |||
| -rw-r--r-- | docs/source/quick_start/rtthread.rst (renamed from docs/source/quick_start/rt-thread/rtthread.rst) | 2 | ||||
| -rw-r--r-- | docs/source/quick_start/transplant.rst (renamed from docs/source/quick_start/other_chip.rst) | 0 |
17 files changed, 19 insertions, 0 deletions
diff --git a/docs/source/quick_start/index.rst b/docs/source/quick_start/demo.rst index a108143f..a108143f 100644 --- a/docs/source/quick_start/index.rst +++ b/docs/source/quick_start/demo.rst diff --git a/docs/source/quick_start/esp.rst b/docs/source/quick_start/esp.rst new file mode 100644 index 00000000..29639e05 --- /dev/null +++ b/docs/source/quick_start/esp.rst @@ -0,0 +1,17 @@ +基于 ESP-Registry 开发指南 +=========================== + +ESP-Registry 可以参考官方文档,推荐使用 vscode + esp-idf 的开发环境。 + +- ctrl + shift + p 选择 ESP-IDF 欢迎界面,然后选择 Component mananger + +.. figure:: img/esp1.png + +- 找到 cherryusb 并安装 + +.. figure:: img/esp2.png + +- 打开 menuconfig,并打开 cherryusb 的配置,根据实际情况选择主机或者从机模式 + +.. figure:: img/esp3.png +.. figure:: img/esp4.png
\ No newline at end of file diff --git a/docs/source/quick_start/rt-thread/img/env0.png b/docs/source/quick_start/img/env0.png Binary files differindex c0a8b03f..c0a8b03f 100644 --- a/docs/source/quick_start/rt-thread/img/env0.png +++ b/docs/source/quick_start/img/env0.png diff --git a/docs/source/quick_start/rt-thread/img/env1.png b/docs/source/quick_start/img/env1.png Binary files differindex 2a68e052..2a68e052 100644 --- a/docs/source/quick_start/rt-thread/img/env1.png +++ b/docs/source/quick_start/img/env1.png diff --git a/docs/source/quick_start/rt-thread/img/env2.png b/docs/source/quick_start/img/env2.png Binary files differindex ee37101a..ee37101a 100644 --- a/docs/source/quick_start/rt-thread/img/env2.png +++ b/docs/source/quick_start/img/env2.png diff --git a/docs/source/quick_start/img/esp1.png b/docs/source/quick_start/img/esp1.png Binary files differnew file mode 100644 index 00000000..1f059e71 --- /dev/null +++ b/docs/source/quick_start/img/esp1.png diff --git a/docs/source/quick_start/img/esp2.png b/docs/source/quick_start/img/esp2.png Binary files differnew file mode 100644 index 00000000..fd20e9ce --- /dev/null +++ b/docs/source/quick_start/img/esp2.png diff --git a/docs/source/quick_start/img/esp3.png b/docs/source/quick_start/img/esp3.png Binary files differnew file mode 100644 index 00000000..82a7162f --- /dev/null +++ b/docs/source/quick_start/img/esp3.png diff --git a/docs/source/quick_start/img/esp4.png b/docs/source/quick_start/img/esp4.png Binary files differnew file mode 100644 index 00000000..ffb2882a --- /dev/null +++ b/docs/source/quick_start/img/esp4.png diff --git a/docs/source/quick_start/rt-thread/img/stm32_init.png b/docs/source/quick_start/img/stm32_init.png Binary files differindex 3ce57201..3ce57201 100644 --- a/docs/source/quick_start/rt-thread/img/stm32_init.png +++ b/docs/source/quick_start/img/stm32_init.png diff --git a/docs/source/quick_start/rt-thread/img/stm32_init2.png b/docs/source/quick_start/img/stm32_init2.png Binary files differindex eae3c026..eae3c026 100644 --- a/docs/source/quick_start/rt-thread/img/stm32_init2.png +++ b/docs/source/quick_start/img/stm32_init2.png diff --git a/docs/source/quick_start/rt-thread/img/stm32cubemx0.png b/docs/source/quick_start/img/stm32cubemx0.png Binary files differindex 1ea33e04..1ea33e04 100644 --- a/docs/source/quick_start/rt-thread/img/stm32cubemx0.png +++ b/docs/source/quick_start/img/stm32cubemx0.png diff --git a/docs/source/quick_start/rt-thread/img/stm32cubemx1.png b/docs/source/quick_start/img/stm32cubemx1.png Binary files differindex a6ca5078..a6ca5078 100644 --- a/docs/source/quick_start/rt-thread/img/stm32cubemx1.png +++ b/docs/source/quick_start/img/stm32cubemx1.png diff --git a/docs/source/quick_start/rt-thread/img/stm32cubemx2.png b/docs/source/quick_start/img/stm32cubemx2.png Binary files differindex e29254bb..e29254bb 100644 --- a/docs/source/quick_start/rt-thread/img/stm32cubemx2.png +++ b/docs/source/quick_start/img/stm32cubemx2.png diff --git a/docs/source/quick_start/rt-thread/img/stm32cubemx_clk.png b/docs/source/quick_start/img/stm32cubemx_clk.png Binary files differindex 41a7aae8..41a7aae8 100644 --- a/docs/source/quick_start/rt-thread/img/stm32cubemx_clk.png +++ b/docs/source/quick_start/img/stm32cubemx_clk.png diff --git a/docs/source/quick_start/rt-thread/rtthread.rst b/docs/source/quick_start/rtthread.rst index a9303715..062e6eab 100644 --- a/docs/source/quick_start/rt-thread/rtthread.rst +++ b/docs/source/quick_start/rtthread.rst @@ -1,6 +1,8 @@ 基于 RT-Thread 软件包开发指南 =============================== +.. note:: CherryUSB 已经加入 RT-Thread 主线,可以选择使用主线版本,配置方式相同。 + 本节主要介绍使用 RT-Thread 提供的软件包管理器来配置工程,以 env 作为演示。本节操作不同芯片都一样,后续不再重复讲解。打开 env 以后使用 menuconfig 进入包管理器,并在如图所示路径中选择 CherryUSB。 .. figure:: img/env0.png diff --git a/docs/source/quick_start/other_chip.rst b/docs/source/quick_start/transplant.rst index 0f8e4b92..0f8e4b92 100644 --- a/docs/source/quick_start/other_chip.rst +++ b/docs/source/quick_start/transplant.rst |
