Просмотр исходного кода

docs: update opensource rst

Signed-off-by: sakumisu <1203593632@qq.com>
sakumisu 3 дней назад
Родитель
Сommit
0ffa68c6c6

+ 1 - 2
docs/en/index.rst

@@ -58,7 +58,6 @@ Considering USB performance requirements to reach theoretical USB hardware bandw
    quick_start/rtthread
    quick_start/q&a
    quick_start/migration
-   quick_start/share
    quick_start/opensource
 
 .. toctree::
@@ -143,7 +142,7 @@ Considering USB performance requirements to reach theoretical USB hardware bandw
 
 .. toctree::
    :maxdepth: 1
-   :caption: Version Information
+   :caption: Release Notes
 
    version
 

+ 73 - 61
docs/en/quick_start/opensource.rst

@@ -1,61 +1,73 @@
-Official Open Source Project Sharing
-=========================================
-
-In addition to basic vendor SDK support, we have also supported some popular open source projects to help developers better use these projects. Below are the adapted demo project links. For specific adaptation layers, refer to https://github.com/cherry-embedded/CherryUSB/tree/master/platform.
-
-DAPLINK
---------------
-
-Adaptation link: https://github.com/cherry-embedded/CherryDAP
-
-Blackmagic
---------------
-
-Adaptation link: https://github.com/zhangjiance/bmp-hpm-port
-
-RT-Thread
---------------
-
-Adaptation link: https://github.com/RT-Thread/rt-thread
-
-NUTTX/VELA
---------------
-
-Adaptation link: https://github.com/CherryUSB/cherryusb_nuttx
-
-Zephyr
---------------
-
-Adaptation link: https://github.com/hpmicro/zephyr_sdk_glue
-
-Cangaroo
---------------
-
-Cangaroo is an open source CAN bus analyzer software. We provide four-channel CANFD analyzer based on hpmicro hpm5361
-
-Host computer adaptation link: https://github.com/RCSN/cangaroo_hpmicro_canfd_analyzer
-Lower computer adaptation link: https://github.com/RCSN/hpm_sdk_extra/tree/main/demos/cangaroo_hpmicro
-
-LVGL
---------------
-
-Adaptation link: https://github.com/cherry-embedded/CherryUSB/tree/master/platform/lvgl
-
-QMK
---------------
-
-QMK is an open-source keyboard firmware for Atmel AVR and Arm USB families.
-
-Adaptation link: To be released
-
-Klipper
---------------
-
-Klipper is a 3D-printer firmware.
-
-Adaptation link: To be released
-
-MAKCU/KMBOX
---------------
-
-Those who know, know - not released
+OpenSource based on CherryUSB
+==================================
+
+.. list-table::
+    :widths: 10 10 10
+    :header-rows: 1
+
+    * - Repo name
+      - Author
+      - Repo url
+    * - RT-Thread
+      - RT-Thread/cherry-embedded
+      - https://github.com/RT-Thread/rt-thread
+    * - DAPLINK/HSLINK-PRO
+      - cherry-embedded
+      - https://github.com/cherry-embedded/CherryDAP https://github.com/cherry-embedded/HSLink-hardware
+    * - HSCANT
+      - cherry-embedded
+      - https://github.com/cherry-embedded/HSCanT-hardware https://github.com/RCSN/cangaroo_hpmicro_canfd_analyzer
+    * - Zephyr
+      - hpmicro
+      - https://github.com/hpmicro/zephyr_sdk_glue
+    * - Blackmagic
+      - zhangjiance
+      - https://github.com/zhangjiance/bmp-hpm-port
+    * - MicroLink
+      - Aladdin-Wang
+      - https://github.com/Aladdin-Wang/MicroLink
+    * - NUTTX
+      - cherry-embedded
+      - https://github.com/CherryUSB/cherryusb_nuttx
+    * - QMK
+      - cherry-embedded
+      - not open
+    * - Klipper
+      - cherry-embedded
+      - not open
+    * - MAKCU/MAKXD
+      - ihack/cherry-embedded
+      - https://discord.gg/makcu https://www.makcu.com
+    * - KMBOX 8K
+      - kmbox team
+      - https://www.kmbox.top
+    * - printalyzer-timer
+      - dkonigsberg
+      - https://github.com/dektronics/printalyzer-timer
+    * - MiSTeryNano
+      - harbaum
+      - https://github.com/harbaum/MiSTeryNano
+    * - PicoPiFi
+      - sidd-kishan
+      - https://github.com/sidd-kishan/PicoPiFi
+    * - Cherryuf2
+      - zhaqian12
+      - https://github.com/zhaqian12/Cherryuf2
+    * - phobia
+      - rombrew
+      - https://github.com/rombrew/phobia
+    * - FMT-Firmware
+      - Firmament-Autopilot
+      - https://github.com/Firmament-Autopilot/FMT-Firmware
+    * - sdk-bsp-stm32h7r-realthread-artpi2
+      - RT-Thread
+      - https://github.com/RT-Thread-Studio/sdk-bsp-stm32h7r-realthread-artpi2
+    * - sdk-bsp-psoc_e84-edgi-talk
+      - RT-Thread
+      - https://github.com/RT-Thread-Studio/sdk-bsp-psoc_e84-edgi-talk
+    * - sdk-bsp-rk3506-realthread-ruichingpi
+      - RT-Thread
+      - https://github.com/RT-Thread-Studio/sdk-bsp-rk3506-realthread-ruichingpi
+    * - f1c200s_library
+      - lhdjply
+      - https://gitee.com/lhdjply/f1c200s_library

+ 0 - 27
docs/en/quick_start/share.rst

@@ -1,27 +0,0 @@
-Developer Experience/Open Source Project Sharing
-====================================================
-
-- `RT-Thread-CherryUSB - RT-Thread <https://club.rt-thread.org/ask/tag/5f5f851966917b14.html?type=article>`_
-
-- `[HPM-DIY]hpm6750 USB开源协议栈性能对比-cherryusb or tinyusb? <https://bbs.eeworld.com.cn/thread-1212755-1-1.html>`_
-
-- `RT-Thread-CherryUSB移植笔记(一):APM32F407VGT6 DWC2移植 Port.A Full-Speed + Por.B High-SpeedRT-Thread问答社区 - RT-Thread <https://club.rt-thread.org/ask/article/3e893614c58da7aa.html>`_
-
-- `华大HC32F460XXX移植cherryusb协议栈,实现USB CDC ACM_cherryusb移植教程-CSDN博客 <https://blog.csdn.net/u011404840/article/details/142180703>`_
-
-- `rt-thread使用cherryusb实现虚拟串口-CSDN博客 <https://blog.csdn.net/weixin_45919462/article/details/143872583>`_
-
-- `F1C100S+rtt+CherryUSB的USB HOST成功读到U盘 / 全志 SOC / WhyCan Forum(哇酷开发者社区) <https://whycan.com/t_10289.html>`_
-
-- `模仿stm32标准库风格写的库文件(f1c100s/f1c200s),且已移植了rt-thread、lvgl、fatfs、cherryusb / 全志 SOC / WhyCan Forum(哇酷开发者社区) <https://whycan.com/t_10475.html>`_
-
-- `printalyzer-timer: F-Stop enlarging timer and print exposure meter <https://github.com/dektronics/printalyzer-timer>`_
-
-- `MiSTeryNano: Atari STE MiSTery core for the Tang Nano 20k FPGA <https://github.com/harbaum/MiSTeryNano>`_
-
-- `Cherryuf2 <https://github.com/zhaqian12/Cherryuf2>`_
-
-- `PicoPiFi: Driverless RNDIS USB WIFI Dongle <https://github.com/sidd-kishan/PicoPiFi>`_
-
-- `phobia: Phobia Motor Controller <https://github.com/rombrew/phobia>`_
-

+ 1 - 2
docs/zh/index.rst

@@ -58,7 +58,6 @@ CherryUSB 是一个小而美的、可移植性高的、用于嵌入式系统的
    quick_start/rtthread
    quick_start/q&a
    quick_start/migration
-   quick_start/share
    quick_start/opensource
 
 .. toctree::
@@ -143,7 +142,7 @@ CherryUSB 是一个小而美的、可移植性高的、用于嵌入式系统的
 
 .. toctree::
    :maxdepth: 1
-   :caption: 版本说明
+   :caption: Release Notes
 
    version
 

+ 73 - 62
docs/zh/quick_start/opensource.rst

@@ -1,62 +1,73 @@
-官方开源项目分享
-====================
-
-除了基本的厂家 SDK 支持以外,我们还对一些火热的开源项目进行了支持,以便于开发者更好的使用这些项目。下面列举适配的 demo 工程链接,具体适配层参考 https://github.com/cherry-embedded/CherryUSB/tree/master/platform 。
-
-DAPLINK
---------------
-
-适配链接:https://github.com/cherry-embedded/CherryDAP
-
-Blackmagic
---------------
-
-适配链接:https://github.com/zhangjiance/bmp-hpm-port
-
-RT-Thread
---------------
-
-适配链接:https://github.com/RT-Thread/rt-thread
-
-NUTTX/VELA
---------------
-
-适配链接:https://github.com/CherryUSB/cherryusb_nuttx
-
-Zephyr
---------------
-
-适配链接:https://github.com/hpmicro/zephyr_sdk_glue
-
-Cangaroo
---------------
-
-Cangaroo is an open source can bus analyzer software. We provide four-channel CANFD analyzer based on hpmicro hpm5361
-
-适配上位机链接:https://github.com/RCSN/cangaroo_hpmicro_canfd_analyzer
-适配下位机链接:https://github.com/RCSN/hpm_sdk_extra/tree/main/demos/cangaroo_hpmicro
-
-LVGL
---------------
-
-适配链接:https://github.com/cherry-embedded/CherryUSB/tree/master/platform/lvgl
-
-QMK
---------------
-
-QMK is an open-source keyboard firmware for Atmel AVR and Arm USB families.
-
-适配链接:待开放
-
-Klipper
---------------
-
-Klipper is a 3d-printer firmware.
-
-适配链接:待开放
-
-
-MAKCU/KMBOX
---------------
-
-懂的都懂,不开放
+基于 CherryUSB 的开源项目
+==================================
+
+.. list-table::
+    :widths: 10 10 10
+    :header-rows: 1
+
+    * - Repo name
+      - Author
+      - Repo url
+    * - RT-Thread
+      - RT-Thread/cherry-embedded
+      - https://github.com/RT-Thread/rt-thread
+    * - DAPLINK/HSLINK-PRO
+      - cherry-embedded
+      - https://github.com/cherry-embedded/CherryDAP https://github.com/cherry-embedded/HSLink-hardware
+    * - HSCANT
+      - cherry-embedded
+      - https://github.com/cherry-embedded/HSCanT-hardware https://github.com/RCSN/cangaroo_hpmicro_canfd_analyzer
+    * - Zephyr
+      - hpmicro
+      - https://github.com/hpmicro/zephyr_sdk_glue
+    * - Blackmagic
+      - zhangjiance
+      - https://github.com/zhangjiance/bmp-hpm-port
+    * - MicroLink
+      - Aladdin-Wang
+      - https://github.com/Aladdin-Wang/MicroLink
+    * - NUTTX
+      - cherry-embedded
+      - https://github.com/CherryUSB/cherryusb_nuttx
+    * - QMK
+      - cherry-embedded
+      - not open
+    * - Klipper
+      - cherry-embedded
+      - not open
+    * - MAKCU/MAKXD
+      - ihack/cherry-embedded
+      - https://discord.gg/makcu https://www.makcu.com
+    * - KMBOX 8K
+      - kmbox team
+      - https://www.kmbox.top
+    * - printalyzer-timer
+      - dkonigsberg
+      - https://github.com/dektronics/printalyzer-timer
+    * - MiSTeryNano
+      - harbaum
+      - https://github.com/harbaum/MiSTeryNano
+    * - PicoPiFi
+      - sidd-kishan
+      - https://github.com/sidd-kishan/PicoPiFi
+    * - Cherryuf2
+      - zhaqian12
+      - https://github.com/zhaqian12/Cherryuf2
+    * - phobia
+      - rombrew
+      - https://github.com/rombrew/phobia
+    * - FMT-Firmware
+      - Firmament-Autopilot
+      - https://github.com/Firmament-Autopilot/FMT-Firmware
+    * - sdk-bsp-stm32h7r-realthread-artpi2
+      - RT-Thread
+      - https://github.com/RT-Thread-Studio/sdk-bsp-stm32h7r-realthread-artpi2
+    * - sdk-bsp-psoc_e84-edgi-talk
+      - RT-Thread
+      - https://github.com/RT-Thread-Studio/sdk-bsp-psoc_e84-edgi-talk
+    * - sdk-bsp-rk3506-realthread-ruichingpi
+      - RT-Thread
+      - https://github.com/RT-Thread-Studio/sdk-bsp-rk3506-realthread-ruichingpi
+    * - f1c200s_library
+      - lhdjply
+      - https://gitee.com/lhdjply/f1c200s_library

+ 0 - 27
docs/zh/quick_start/share.rst

@@ -1,27 +0,0 @@
-开发者经验/开源项目分享
-========================
-
-- `RT-Thread-CherryUSB - RT-Thread <https://club.rt-thread.org/ask/tag/5f5f851966917b14.html?type=article>`_
-
-- `[HPM-DIY]hpm6750 USB开源协议栈性能对比-cherryusb or tinyusb? <https://bbs.eeworld.com.cn/thread-1212755-1-1.html>`_
-
-- `RT-Thread-CherryUSB移植笔记(一):APM32F407VGT6 DWC2移植 Port.A Full-Speed + Por.B High-SpeedRT-Thread问答社区 - RT-Thread <https://club.rt-thread.org/ask/article/3e893614c58da7aa.html>`_
-
-- `华大HC32F460XXX移植cherryusb协议栈,实现USB CDC ACM_cherryusb移植教程-CSDN博客 <https://blog.csdn.net/u011404840/article/details/142180703>`_
-
-- `rt-thread使用cherryusb实现虚拟串口-CSDN博客 <https://blog.csdn.net/weixin_45919462/article/details/143872583>`_
-
-- `F1C100S+rtt+CherryUSB的USB HOST成功读到U盘 / 全志 SOC / WhyCan Forum(哇酷开发者社区) <https://whycan.com/t_10289.html>`_
-
-- `模仿stm32标准库风格写的库文件(f1c100s/f1c200s),且已移植了rt-thread、lvgl、fatfs、cherryusb / 全志 SOC / WhyCan Forum(哇酷开发者社区) <https://whycan.com/t_10475.html>`_
-
-- `printalyzer-timer: F-Stop enlarging timer and print exposure meter <https://github.com/dektronics/printalyzer-timer>`_
-
-- `MiSTeryNano: Atari STE MiSTery core for the Tang Nano 20k FPGA <https://github.com/harbaum/MiSTeryNano>`_
-
-- `Cherryuf2 <https://github.com/zhaqian12/Cherryuf2>`_
-
-- `PicoPiFi: Driverless RNDIS USB WIFI Dongle <https://github.com/sidd-kishan/PicoPiFi>`_
-
-- `phobia: Phobia Motor Controller <https://github.com/rombrew/phobia>`_
-