update maixpy doc

sipeed · May 9, 2024 · 5d616dc · 5d616dc
1 parent 93d2e1c
commit 5d616dc
Show file tree

Hide file tree

Showing 11 changed files with 392 additions and 218 deletions.
diff --git a/README.md b/README.md
@@ -99,9 +99,9 @@ And we provide new powerful hardware platform **[MaixCAM](https://wiki.sipeed.co
 | --- | --- | ------- |
 | - 1GHz RISC-V(Linux)/ARM A53<br>- 700MHz RISCV-V(RTOS)<br>- 25~300MHz 8051(LowPower) | 1Tops@INT8 NPU, support BF16<br>support YOLOv5 YOLOv8 etc.| 256MB DDR3 |
 
-| Connecting | Peripheral | MultiMedia | Price |
+| Connecting | Peripheral | MultiMedia | Buy |
 | ----------- | ----- | --- | ---- |
-|  USB2.0/WiFi6/BLE5.4 | IIC/PWM/SPI/UART/WDT/ADC | - 4M Camera<br>- 2.3" 552x368 Touchscreen<br>- H.264/H.265/MJPEG codec | [￥169/￥249](https://wiki.sipeed.com/store) |
+|  USB2.0/WiFi6/BLE5.4 | IIC/PWM/SPI/UART/WDT/ADC | - 4M Camera<br>- 2.3" 552x368 Touchscreen<br>- H.264/H.265/MJPEG codec | [Sipeed Official Store](https://wiki.sipeed.com/store) |
 
 Chip register level open, more detalils: [MaixCAM](https://wiki.sipeed.com/maixcam)
 

diff --git a/docs/doc/en/basic/maixvision.md b/docs/doc/en/basic/maixvision.md
@@ -4,12 +4,16 @@ title: MaixVision - MaixPy Programming + Graphical Block Programming
 
 ## Introduction
 
-MaixVision is a developer programming tool specifically designed for the Maix ecosystem, supporting MaixPy programming and graphical block programming. It also supports online running, debugging, and real-time image preview, allowing the synchronization of the device display screen for easy debugging and development.
+[MaixVision](https://wiki.sipeed.com/maixvision) is a developer programming tool specifically designed for the Maix ecosystem, supporting MaixPy programming and graphical block programming. It also supports online running, debugging, and real-time image preview, allowing the synchronization of the device display screen for easy debugging and development.
 
 It also supports packaging applications and installing them on devices, making it convenient for users to generate and install applications with a single click.
 
 Additionally, it integrates some handy development tools, such as file management, threshold editors, QR code generators, and more.
 
+## Download
+
+Visit [MaixVision home page](https://wiki.sipeed.com/maixvision) to download.
+
 ## Using MaixPy Programming and Online Running
 
 By following the steps in the [Quick Start](../README.md), we can easily use MaixPy programming and run programs online.

diff --git a/docs/doc/en/projects/README.md b/docs/doc/en/projects/README.md
@@ -0,0 +1,38 @@
+---
+title: Practical Projects with MaixPy, Introduction and Collection
+---
+
+## Introduction
+
+Here we provide some common practical project examples for community members to refer to and replicate for use. This also helps to inspire everyone to create more and better applications and projects.
+
+There are several ways to find projects implemented with MaixPy:
+
+## MaixPy Official Documentation
+
+You can find practical projects in the documentation on the left, such as "Line Following Car."
+
+If you have a good project or a recommended project, you can also contribute by adding it to the documentation.
+
+
+## MaixHub Project Sharing Square
+
+Projects can be found in the [MaixHub Project Sharing](https://maixhub.com/share?type=project) section.
+
+High-quality shares will also be linked to the MaixPy official documentation.
+
+You can also share your project-making methods, which will receive official rewards (guaranteed) and cash tips from community members (usually, high-quality projects that meet urgent needs are more likely to be tipped).
+
+Recommend Projects:
+* maixcam deploy yolov5s model: https://maixhub.com/share/23
+
+
+
+## MaixHub App Sharing
+
+In addition to project sharing, you can also find directly runnable applications at the [MaixHub App Store](https://maixhub.com/app), some of which might be written in MaixPy. If the author has provided the source code or written detailed tutorials, these can also be referred to.
+
+Recommend Projects:
+* Simple HTTP Streaming Server: https://maixhub.com/app/19
+* Desktop Computer Performance Monitor: https://maixhub.com/app/13
+* Safety Helmet Detection Model Application: https://maixhub.com/app/10
diff --git a/docs/doc/en/projects/line_tracking_robot.md b/docs/doc/en/projects/line_tracking_robot.md
@@ -0,0 +1,5 @@
+---
+title: MaixPy Line Tracking Robot (/Car)
+---
+
+
diff --git a/docs/doc/en/sidebar.yaml b/docs/doc/en/sidebar.yaml
@@ -2,128 +2,144 @@ items:
 -   file: README.md
     label: Quick Start
 -   file: faq.md
-    label: FAQ 
+    label: FAQ
 
 -   label: Base
--   file: basic/os.md
-    label: Burning system
--   file: basic/app_usage.md
-    label: App uses
--   file: basic/maixpy_upgrade.md
-    label: Update MaixPy
--   file: basic/maixvision.md
-    label: MaixVision uses
--   file: basic/python.md
-    label: Python syntax
--   file: basic/linux_basic.md
-    label: Linux fundamentals
--   file: basic/python_pkgs.md
-    label: Add python packages
--   file: basic/app.md
-    label: Apps development
+    collapsed: false
+    items:
+    -   file: basic/os.md
+        label: Burning system
+    -   file: basic/app_usage.md
+        label: App uses
+    -   file: basic/maixpy_upgrade.md
+        label: Update MaixPy
+    -   file: basic/maixvision.md
+        label: MaixVision uses
+    -   file: basic/python.md
+        label: Python syntax
+    -   file: basic/linux_basic.md
+        label: Linux fundamentals
+    -   file: basic/python_pkgs.md
+        label: Add python packages
+    -   file: basic/app.md
+        label: Apps development
 
 -   label: Basic images and algorithms
--   file: vision/display.md
-    label: Screen uses
--   file: vision/camera.md
-    label: Camera uses
--   file: vision/image_ops.md
-    label: Image control
--   file: vision/find_blobs.md
-    label: Finding color blocks
--   file: vision/line_tracking.md
-    label: Line tracking
--   file: vision/qrcode.md
-    label: QRcode identity
--   file: vision/apriltag.md
-    label: AprilTag identity
+    items:
+    -   file: vision/display.md
+        label: Screen uses
+    -   file: vision/camera.md
+        label: Camera uses
+    -   file: vision/image_ops.md
+        label: Image control
+    -   file: vision/find_blobs.md
+        label: Finding color blocks
+    -   file: vision/line_tracking.md
+        label: Line tracking
+    -   file: vision/qrcode.md
+        label: QRcode identity
+    -   file: vision/apriltag.md
+        label: AprilTag identity
 
 -   label: AI Vision
--   file: vision/ai.md
-    label: AI vision knowledge
--   file: vision/classify.md
-    label: AI object classify
--   file: vision/yolov5.md
-    label: YOLOv5 object detect
--   file: vision/face_recognition.md
-    label: Face detect
--   file: vision/body_key_points.md
-    label: Human critical point detection
--   file: vision/self_learn_classifier.md
-    label: Self-learning classifier
--   file: vision/self_learn_detector.md
-    label: Self-learning detector
--   file: vision/object_track.md
-    label: Object tracking and counting
--   file: vision/ocr.md
-    label: OCR 
--   file: vision/maixhub_train.md
-    label: MaixHub online AI training
--   file: vision/custmize_model.md
-    label: Custom model
+    items:
+    -   file: vision/ai.md
+        label: AI vision knowledge
+    -   file: vision/classify.md
+        label: AI object classify
+    -   file: vision/yolov5.md
+        label: YOLOv5 object detect
+    -   file: vision/face_recognition.md
+        label: Face detect
+    -   file: vision/body_key_points.md
+        label: Human critical point detection
+    -   file: vision/self_learn_classifier.md
+        label: Self-learning classifier
+    -   file: vision/self_learn_detector.md
+        label: Self-learning detector
+    -   file: vision/object_track.md
+        label: Object tracking and counting
+    -   file: vision/ocr.md
+        label: OCR 
+    -   file: vision/maixhub_train.md
+        label: MaixHub online AI training
+    -   file: vision/custmize_model.md
+        label: Custom model
 
 
 -   label: AI audio
--   file: audio/record.md
-    label: Audio record
--   file: audio/play.md
-    label: Play audio
--   file: audio/classifier.md
-    label: AI voice classifier
--   file: audio/keyword.md
-    label: Keyword recognize
--   file: audio/recognize.md
-    label: Real-time voice recognize
--   file: audio/synthesis.md
-    label: Speech synthesis
+    items:
+    -   file: audio/record.md
+        label: Audio record
+    -   file: audio/play.md
+        label: Play audio
+    -   file: audio/classifier.md
+        label: AI voice classifier
+    -   file: audio/keyword.md
+        label: Keyword recognize
+    -   file: audio/recognize.md
+        label: Real-time voice recognize
+    -   file: audio/synthesis.md
+        label: Speech synthesis
 
 -   label: Video
--   file: video/record.md
-    label: Video record
--   file: video/play.md
-    label: Play video
--   file: video/jpeg_streaming.md
-    label: JPEG stream
--   file: video/rtsp.md
-    label: RTSP stream
+    items:
+    -   file: video/record.md
+        label: Video record
+    -   file: video/play.md
+        label: Play video
+    -   file: video/jpeg_streaming.md
+        label: JPEG stream
+    -   file: video/rtsp.md
+        label: RTSP stream
 
 
 -   label: On-chip peripherals
--   file: peripheral/gpio.md
-    label: GPIO
--   file: peripheral/uart.md
-    label: UART
--   file: peripheral/i2c.md
-    label: I2C
--   file: peripheral/pwm.md
-    label: PWM
--   file: peripheral/spi.md
-    label: SPI
--   file: peripheral/wdt.md
-    label: WDT watchdog
+    items:
+    -   file: peripheral/gpio.md
+        label: GPIO
+    -   file: peripheral/uart.md
+        label: UART
+    -   file: peripheral/i2c.md
+        label: I2C
+    -   file: peripheral/pwm.md
+        label: PWM
+    -   file: peripheral/spi.md
+        label: SPI
+    -   file: peripheral/wdt.md
+        label: WDT watchdog
 
 -   label: Off-chip modules
--   file: modules/acc.md
-    label: Accelerometer
--   file: modules/temp_hum.md
-    label: Temperature and humidity
--   file: modules/tof.md
-    label: TOF
--   file: modules/thermal_cam.md
-    label: Thermal imaging
+    items:
+    -   file: modules/acc.md
+        label: Accelerometer
+    -   file: modules/temp_hum.md
+        label: Temperature and humidity
+    -   file: modules/tof.md
+        label: TOF
+    -   file: modules/thermal_cam.md
+        label: Thermal imaging
+
+-   label: Porjects
+    items:
+    -   file: projects/README.md
+        label: Intro & Collection
+    -   file: projects/line_tracking_robot.md
+        label: Line tracking robot
 
 -   label: Advanced
--   file: source_code/contribute.md
-    label: Contribute
--   file: source_code/build.md
-    label: Build source code
--   file: source_code/faq.md
-    label: MaixPy Source FAQ
--   file: source_code/add_c_module.md
-    label: Write in C/C++
--   file: source_code/maixcdk.md
-    label: MaixCDK develop
--   file: pro/compile_os.md
-    label: Build firmware
+    items:
+    -   file: source_code/contribute.md
+        label: Contribute
+    -   file: source_code/build.md
+        label: Build source code
+    -   file: source_code/faq.md
+        label: MaixPy Source FAQ
+    -   file: source_code/add_c_module.md
+        label: Write in C/C++
+    -   file: source_code/maixcdk.md
+        label: MaixCDK develop
+    -   file: pro/compile_os.md
+        label: Build firmware
 
 
diff --git a/docs/doc/en/source_code/build.md b/docs/doc/en/source_code/build.md
@@ -5,14 +5,33 @@ title: MaixPy develop source code guide
 ## Get source code
 
 ```shell
+mkdir -p ~/maix
+cd ~/maix
 git clone https://github.com/sipeed/MaixPy
-cd MaixPy
 ```
 
-## Build and pack to wheel
+## Getting MaixCDK Source Code
+
+The MaixPy project depends on MaixCDK. You need to clone it first and place it in a directory on your computer (do not place it under the MaixPy directory).
+
+```shell
+cd ~/maix
+git clone https://github.com/sipeed/MaixCDK
+```
+
+Then, you need to set the environment variable MAIXCAK_PATH to specify the path to MaixCDK, which can be added in ~/.bashrc or ~/.zshrc (depending on your shell):
+
+```shell
+export MAIXCAK_PATH=~/maix/MaixCDK
+```
 
+Only after successfully setting the environment variable can MaixPy locate the MaixCDK source code.
+
+
+## Build and pack to wheel
 
 ```shell
+cd ~/maix/MaixPy
 python setup.py bdist_wheel maixcam
 ```
 
@@ -23,6 +42,9 @@ After build success, you will find wheel file in `dist` directory, use `pip inst
 
 > `python setup.py bdist_wheel maixcam --skip-build` will not execute build command and only pack wheel, so you can use `maixcdk menuconfig` and `maixcdk build` first to customize building.
 
+> Additionally, if you are debugging APIs and need to install frequently, using pip can be slow. You can compile and then copy the maix directory directly to the /usr/lib/python3.11/site-packages directory on your device to overwrite the old files.
+
+
 ## Build manually
 
 ```shell

diff --git a/docs/doc/zh/basic/maixvision.md b/docs/doc/zh/basic/maixvision.md
@@ -5,12 +5,17 @@ title: MaixVision -- MaixPy 编程 + 图形化积木编程
 
 ## 简介
 
-MaixVision 是专为 Maix 生态打造的一款开发者编程工具，支持 MaixPy 编程和图形化积木编程，同时支持在线运行和调试，以及实时预览图像，可以同步设备显示屏的图像，方便调试和开发。
+[MaixVision](https://wiki.sipeed.com/maixvision) 是专为 Maix 生态打造的一款开发者编程工具，支持 MaixPy 编程和图形化积木编程，同时支持在线运行和调试，以及实时预览图像，可以同步设备显示屏的图像，方便调试和开发。
 
 以及支持打包应用和安装应用到设备，方便用户一键生成、安装应用。
 
 同时还集成一些方便开发的小工具，比如文件管理，阈值编辑器，二维码生成等等。
 
+## 下载
+
+访问 [MaixVision 主页](https://wiki.sipeed.com/maixvision) 下载。
+
+
 ## 使用 MaixPy 编程和在线运行
 
 按照[快速开始](../README.md)的步骤连接设备，我们可以很方便地使用 MaixPy 编程和在线运行。