update doc

README.md

@@ -13,7 +13,7 @@ MaixPy
     <a href="https://wiki.sipeed.com/maixpy/doc/en/index.html"> Quick Start </a> |
     <a href="https://wiki.sipeed.com/maixpy/en/index.html"> Documentation </a> |
     <a href="https://wiki.sipeed.com/maixpy/api/index.html"> API </a> |
-    <a href="https://wiki.sipeed.com/MaixCAM"> Hardware </a>
+    <a href="https://wiki.sipeed.com/maixcam"> Hardware </a>
 </h3>
 
 [![GitHub Repo stars](https://img.shields.io/github/stars/sipeed/MaixPy?style=social)](https://github.com/sipeed/MaixPy/stargazers)
@@ -73,6 +73,22 @@ serial.write_str("hello world")
 print("received:", serial.read(timeout = 2000))
 ```
 
+We also provide a handy **[MaixVision](https://wiki.sipeed.com/en/maixvision)** workstation software to make development easier and faster:
+
+<video controls muted preload src="https://github.com/sipeed/MaixPy/assets/8625829/1168a282-d7c2-45bc-9ffb-c00de1ca24f5" type="video/mp4">
+MaixVision
+</video>
+
+And online AI train platform **[MaixHub](https://maixhub.com)**, one click to train AI model and deploy to MaixCAM even you have no AI knowledge and expensive training equipment.
+
+![MaixHub](https://wiki.sipeed.com/maixpy/static/image/maixhub.jpg)
+
+## Features
+
+Python programing, MaixVision Workstation, AI vision, video streaming, voice recognize, peripheral usage etc.
+
+**Details and videos** visit official site: [wiki.sipeed.com/maixpy/](https://wiki.sipeed.com/maixpy/)
+
 ## Hardware platform MaixCAM
 
 And we provide new powerful hardware platform **[MaixCAM](https://wiki.sipeed.com/maixcam)**:
@@ -87,27 +103,12 @@ And we provide new powerful hardware platform **[MaixCAM](https://wiki.sipeed.co
 | ----------- | ----- | --- | ---- |
 |  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) |
 
-More detalils: [MaixCAM](https://wiki.sipeed.com/maixcam)
+Chip register level open, more detalils: [MaixCAM](https://wiki.sipeed.com/maixcam)
 
 > * Big core can choose one of RISC-V and ARM A53.
 > * **Maix-I K210** series is outdated, MaixPy v4 not support it, use it please visit **[MaixPy-v1](https://github.com/sipeed/maixpy-v1)**
 
 
-## Features
-
-Python programing, MaixVision IDE, AI vision, video streaming, voice recognize, peripheral usage etc.
-
-**Details and videos** visit official site: [wiki.sipeed.com/maixpy/](https://wiki.sipeed.com/maixpy/)
-
-
-## Maix Ecosystem
-
-MaixPy not only a Python SDK, but have a whole ecosystem, including hardware, software, tools, docs, even cloud platform etc.
-See the picture below:
-
-![](https://wiki.sipeed.com/maixpy/static/image/maix_ecosystem.png)
-
-
 ## Who are using MaixPy?
 
 * **AI Algorithm Engineer** who want to deploy your AI model to embedded devices.
@@ -158,6 +159,14 @@ Here's the comparison between them:
 | AI detect   | YOLOv2(224x224) 15fps |  YOLOv2(224x224) 15fps |  **YOLOv5s(224x224) 100fps<br>YOLOv5s(320x256) 70fps<br>YOLOv5s(640x640) 15fps<br>YOLOv8n(640x640) 23fps**|
 | Ease of use     | ⭐️⭐️⭐️⭐️ |  ⭐️⭐️⭐️   |  🌟🌟🌟🌟🌟 |
 
+## Maix Ecosystem
+
+MaixPy not only a Python SDK, but have a whole ecosystem, including hardware, software, tools, docs, even cloud platform etc.
+See the picture below:
+
+![](https://wiki.sipeed.com/maixpy/static/image/maix_ecosystem.png)
+
+
 ## What difference between MaixPy v1, MaixPy3 and MaixPy v4?
 
 * MaixPy v1 use MicroPython programming language, only support Sipeed Maix-I K210 series hardware, have limited third-party packages.
@@ -166,6 +175,11 @@ Here's the comparison between them:
 
 (MaixPy v4 Will not support Maix-I K210 series, if you are using Maix-I K210 series, it's recommended to upgrade hardware platform to use this to get more features and better performance.)
 
+## Compile Source Code
+
+If you want to compile MaixPy firmware from source code, refer to [Build MaixPy source code](https://wiki.sipeed.com/maixpy/doc/en/source_code/build.html) page.
+
+
 ## License
 
 All files in this repository are under the terms of the [Apache License 2.0 Sipeed Ltd.](./LICENSE) except the third-party libraries or have their own license.

README_ZH.md

@@ -13,7 +13,7 @@ MaixPy
     <a href="https://wiki.sipeed.com/maixpy/doc/en/index.html"> 快速开始 </a> |
     <a href="https://wiki.sipeed.com/maixpy/en/index.html"> 文档 </a> |
     <a href="https://wiki.sipeed.com/maixpy/api/index.html"> API </a> |
-    <a href="https://wiki.sipeed.com/MaixCAM"> 硬件 </a>
+    <a href="https://wiki.sipeed.com/maixcam"> 硬件 </a>
 </h3>
 
 [![GitHub Repo stars](https://img.shields.io/github/stars/sipeed/MaixPy?style=social)](https://github.com/sipeed/MaixPy/stargazers)
@@ -73,6 +73,23 @@ serial.write_str("hello world")
 print("received:", serial.read(timeout = 2000))
 ```
 
+我们还提供了便捷的 **[MaixVision](https://wiki.sipeed.com/maixvision)** 工作站，让开发更简单快速：
+
+<video controls muted preload src="https://github.com/sipeed/MaixPy/assets/8625829/1168a282-d7c2-45bc-9ffb-c00de1ca24f5" type="video/mp4">
+MaixVision
+</video>
+
+以及在线 AI 训练平台 **[MaixHub](https://maixhub.com)**， 无需 AI 基础和昂贵的训练设备，一键训练模型，一键部署到 MaixCAM。
+
+![MaixHub](https://wiki.sipeed.com/maixpy/static/image/maixhub.jpg)
+
+## 功能特点
+
+Python 编程, MaixVision 工作站, AI 视觉, 视频串流, 语音识别, 外设使用 等。
+
+**细节和视频展示** 请访问官网: [wiki.sipeed.com/maixpy/](https://wiki.sipeed.com/maixpy/)
+
+
 ## 硬件平台 MaixCAM
 
 提供性能强劲的硬件平台 **[MaixCAM](https://wiki.sipeed.com/maixcam)**:
@@ -87,28 +104,12 @@ print("received:", serial.read(timeout = 2000))
 | ----------- | ----- | --- | ---- |
 |  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) |
 
-详情看 [MaixCAM](https://wiki.sipeed.com/maixcam)
+芯片寄存器级别开放，详情看 [MaixCAM](https://wiki.sipeed.com/maixcam)
 
 > * 大核在 RISC-V and ARM A53 二选一。
 > * **Maix-I K210** 已过时，MaixPy v4 不支持它, 仍要使用请访问 **[MaixPy-v1](https://github.com/sipeed/maixpy-v1)**
 
 
-## 特点
-
-Python 编程, MaixVision IDE, AI 视觉, 视频串流, 语音识别, 外设使用 等。
-
-**细节和视频展示** 请访问官网: [wiki.sipeed.com/maixpy/](https://wiki.sipeed.com/maixpy/)
-
-
-## Maix 生态系统
-
-
-MaixPy 不仅仅是一个 Python SDK，还有一个完整的生态系统，包括硬件、软件、工具、文档、甚至云平台等。
-看下面的图片:
-
-![](https://wiki.sipeed.com/maixpy/static/image/maix_ecosystem.png)
-
-
 ## 谁在用 MaixPy？
 
 * **AI 算法工程师**： 轻松将你的 AI 模型部署到嵌入式设备。
@@ -161,13 +162,13 @@ MaixPy 不仅仅是一个 Python SDK，还有一个完整的生态系统，包
 | AI 检测   | YOLOv2(224x224) 15fps |  YOLOv2(224x224) 15fps |  **YOLOv5s(224x224) 100fps<br>YOLOv5s(320x256) 70fps<br>YOLOv5s(640x640) 15fps<br>YOLOv8n(640x640) 23fps**|
 | 易用性     | ⭐️⭐️⭐️⭐️ |  ⭐️⭐️⭐️   |  🌟🌟🌟🌟🌟 |
 
-## What difference between MaixPy v1, MaixPy3 and MaixPy v4?
+## Maix 生态系统
 
-* MaixPy v1 use MicroPython programming language, only support Sipeed Maix-I K210 series hardware, have limited third-party packages.
-* MaixPy3 is designed for Sipeed Maix-II-Dock v831, not a long-term support version.
-* MaixPy v4 use Python programming language, so there's much package we can use directly. MaixPy v4 support new hardware platforms of Sipeed, it's a long-term support version, the future's hardware platforms will support this version. MaixPy v4 have a MaixPy-v1 compatible API, so you can quickly migrate your MaixPy v1 project to MaixPy v4.
 
-(MaixPy v4 Will not support Maix-I K210 series, if you are using Maix-I K210 series, it's recommended to upgrade hardware platform to use this to get more features and better performance.)
+MaixPy 不仅仅是一个 Python SDK，还有一个完整的生态系统，包括硬件、软件、工具、文档、甚至云平台等。
+看下面的图片:
+
+![](https://wiki.sipeed.com/maixpy/static/image/maix_ecosystem.png)
 
 ## MaixPy v1, MaixPy3 and MaixPy v4 有什么区别？
 
@@ -177,6 +178,10 @@ MaixPy 不仅仅是一个 Python SDK，还有一个完整的生态系统，包
 
 (MaixPy v4 不支持 Maix-I K210 系列，如果你正在使用 Maix-I K210 系列，建议升级硬件平台以使用此版本，以获得更多功能和更好的性能。)
 
+## 编译 MaixPy 源码
+
+如果你想从源代码编译 MaixPy 固件，请参考 [构建 MaixPy 源码](https://wiki.sipeed.com/maixpy/doc/zh/source_code/build.html) 页面。
+
 ## 开源协议
 
 

docs/doc/zh/README.md

@@ -15,7 +15,7 @@ title: MaixPy 快速开始
 </div>
 <br>
 
-> 关于 MaixPy 介绍请看 [MaixPy 官网首页](../README.md)
+> 关于 MaixPy 介绍请看 [MaixPy 官网首页](../../README.md)
 
 ## 获得 MaixCAM 设备
 

docs/doc/zh/basic/os.md

@@ -18,14 +18,13 @@ title: 升级和烧录系统
 
 ## 获得最新系统
 
+在 [MaixPy 发布页面](https://github.com/sipeed/MaixPy/releases) 找到最新的系统镜像文件，比如`maixcam_os_20240401_maixpy_v4.1.0.xz`。
 
-## 准备烧录工具
+备用地址：
+* [Sourceforge](https://sourceforge.net/projects/maixpy/files/)
 
 
-## 烧录系统
-
-
-## 系统首次启动
-
+## 烧录系统到 MaixCAM
 
+参考 [MaixCAM 系统烧录](https://wiki.sipeed.com/hardware/zh/maixcam/os.html) 教程。
 

docs/doc/zh/source_code/build.md

@@ -2,13 +2,32 @@
 title: MaixPy develop source code guide
 ---
 
+## Get source code
+
+```shell
+git clone https://github.com/sipeed/MaixPy
+cd MaixPy
+```
+
+## Build and pack to wheel
 
-## Build
+
+```shell
+python setup.py bdist_wheel maixcam
+```
+
+`maixcam` Can be replaced with other board config, see [setup.py]([./configs](https://github.com/sipeed/MaixPy/blob/main/setup.py)) 's `platform_names` variable.
+
+
+After build success, you will find wheel file in `dist` directory, use `pip install -U MaixPy****.wheel` on your device to install or upgrade.
+
+> `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.
+
+## Build manually
 
 ```shell
 maixcdk build
 ```
-And if add or delete files, run `maixcdk rebuild`.
 
 ## Run test after modify source code
 
@@ -17,28 +36,22 @@ And if add or delete files, run `maixcdk rebuild`.
 maixcdk build
 ```
 
-* Then go to `test` directory, execute `./run.sh your_test_file_name.py` to run python script.
+* If build for PC self(platform `linux`):
+Then execute `./run.sh your_test_file_name.py` to run python script.
 ```shell
 cd test
-./run.sh test_image.py
+./run.sh examples/hello_maix.py
 ```
 
-## Pack to wheel
-
+* If cross compile for borad:
+  * The fastest way is copy `maix` dir to device's `/usr/lib/python3.11/site-packages/` directory, then run script on device.
+  * Or pack wheel and install on device by `pip install -U MaixPy****.wheel`, then run script on device.
 
-```shell
-python setup.py bdist_wheel linux
-```
-`linux` Can be replaced with other board config, see [configs](./configs) directory
+## Preview documentation locally
 
-> `python setup.py bdist_wheel linux --not-clean` will not execute distclean command, so you can use `maixcdk build` first to customize building.
+Documentation in [docs](https://github.com/sipeed/MaixPy/tree/main/docs) directory, use `Markdown` format, you can use [teedoc](https://github.com/teedoc/teedoc) to generate web version documentation.
 
-After build success, you will find wheel file in dist directory, use `pip install -U MaixPy****.wheel` on you board to install or upgrade.
-
-
-## Documentation
-
-Documentation in [docs][./docs] directory, use `Markdown` format, you can use [teedoc](https://github.com/teedoc/teedoc) to generate web version documentation.
+And the API doc is generated when build MaixPy firmware, **if you don't build MaixPy, the API doc will be empty**.
 
 ```shell
 pip install teedoc -U
@@ -55,3 +68,4 @@ Then visit `http://127.0.0.1:2333` to preview documentation on web browser.
 See [MaixPy develop source code guide](./contribute.md)
 
 If you encounter any problems when use source code, please refer to [FAQ](./faq.md) first.
+

docs/pages/index/README.md

@@ -215,6 +215,23 @@ print("received:", dev1.readfrom(0x12, 5))
 </div>
 <!-- div end-->
 
+<!-- start -->
+<h2>便捷的 MaixVision 工作站</h2>
+
+简化开发环境，让开发更简单快速：
+
+<video controls muted preload src="/static/video/maixvision.mp4" type="video/mp4" style="height:20em;">
+MaixVision
+</video>
+
+<h2>在线 AI 训练平台 MaixHub</h2>
+
+无需 AI 基础和昂贵的训练设备，一键训练模型，一键部署到 MaixCAM。
+
+<img style="height:20em;" src="/static/image/maixhub.jpg">
+
+<!-- end -->
+
 ## 性能强劲 MaixCAM 硬件平台
 
 ![MaixCAM](/static/image/maixcam.png)
@@ -235,6 +252,7 @@ print("received:", dev1.readfrom(0x12, 5))
 
 > 注意，目前只支持 MaixCAM 开发板，其它同型号芯片的开发板均不支持，包括 Sipeed 的同型号芯片开发板，请注意不要买错造成不必要的时间和金钱浪费。
 
+
 <!-- feature 介绍 -->
 
 <div id="feature">
@@ -447,10 +465,6 @@ print("received:", dev1.readfrom(0x12, 5))
 
 </div>
 
-## Maix 生态
-
-![](/static/image/maix_ecosystem.png)
-
 ## 谁在用 MaixPy？
 
 * **AI 算法工程师**： 轻松将你的 AI 模型部署到嵌入式设备。
@@ -503,6 +517,11 @@ print("received:", dev1.readfrom(0x12, 5))
 | AI 检测   | YOLOv2(224x224) 15fps |  YOLOv2(224x224) 15fps |  **YOLOv5s(224x224) 100fps<br>YOLOv5s(320x256) 70fps<br>YOLOv5s(640x640) 15fps<br>YOLOv8n(640x640) 23fps**|
 | 易用性     | ⭐️⭐️⭐️⭐️ |  ⭐️⭐️⭐️   |  🌟🌟🌟🌟🌟 |
 
+## Maix 生态
+
+![](/static/image/maix_ecosystem.png)
+
+
 ## MaixPy v1, MaixPy3 and MaixPy v4 有什么区别？
 
 * MaixPy v1 使用 MicroPython 编程语言，仅支持 Sipeed Maix-I K210 系列硬件，有限的第三方包。

docs/pages/index_en/README.md

@@ -215,6 +215,23 @@ print("received:", dev1.readfrom(0x12, 5))
 </div>
 <!-- div end-->
 
+<!-- start -->
+<h2>MaixVision Workstation</h2>
+
+Simplify the development environment, make development easier and faster:
+
+<video controls muted preload src="/static/video/maixvision.mp4" type="video/mp4" style="height:20em;">
+MaixVision
+</video>
+
+<h2>Online AI training platform MaixHub</h2>
+
+One-click training AI model and deployment to MaixCAM even you have no AI knowledge and expensive training equipment.
+
+<img style="height:20em;" src="/static/image/maixhub.jpg">
+
+<!-- end -->
+
 ## Powerful MaixCAM hardware platform
 
 ![MaixCAM](/static/image/maixcam.png)
@@ -234,6 +251,7 @@ More detalils: [MaixCAM](https://wiki.sipeed.com/maixcam)
 
 > Attention, only MaixCAM is supported, other boards with the same chip are not supported, including Sipeed's boards with the same chip, please be careful not to waste time and money by buying the wrong one.
 
+
 <!-- feature 介绍 -->
 
 <div id="feature">
@@ -446,9 +464,6 @@ Below are some of the features, for more please see the [documentation](/doc/en/
 
 </div>
 
-## Maix ecosystem
-
-![](/static/image/maix_ecosystem.png)
 
 ## Who are using MaixPy?
 
@@ -500,6 +515,11 @@ Here's the comparison between them:
 | AI detect   | YOLOv2(224x224) 15fps |  YOLOv2(224x224) 15fps |  **YOLOv5s(224x224) 100fps<br>YOLOv5s(320x256) 70fps<br>YOLOv5s(640x640) 15fps<br>YOLOv8n(640x640) 23fps**|
 | Ease of use     | ⭐️⭐️⭐️⭐️ |  ⭐️⭐️⭐️   |  🌟🌟🌟🌟🌟 |
 
+## Maix ecosystem
+
+![](/static/image/maix_ecosystem.png)
+
+
 ## What difference between MaixPy v1, MaixPy3 and MaixPy v4?
 
 * MaixPy v1 use MicroPython programming language, only support Sipeed Maix-I K210 series hardware, have limited third-party packages.