本仓库提供嘉楠 Kendryte K230 平台 CanMV 的中英文文档,涵盖开发板入门、固件烧录与编译、CanMV Visual Studio Code 扩展、MicroPython API,以及 AI、图像、多媒体、网络和外设开发示例。
This repository contains the Chinese and English documentation for CanMV on the Canaan Kendryte K230 platform, covering development boards, firmware flashing and builds, the CanMV Visual Studio Code extension, MicroPython APIs, and examples for AI, imaging, multimedia, networking, and peripherals.
| 内容 / Topic | 中文 | English |
|---|---|---|
| 文档首页 / Overview | 文档首页 | Overview |
| 快速入门 / Quick start | 快速入门 | Quick start |
| 开发板 / Development boards | 开发板介绍 | Development boards |
| 烧录固件 / Flash firmware | 烧录指南 | Flashing guide |
| 编译固件 / Build firmware | 编译指南 | Build guide |
| CanMV 扩展 / CanMV extension | 扩展使用说明 | Extension guide |
| 运行示例 / Run examples | 运行示例 | Run examples |
| 示例程序 / Examples | 示例程序 | Examples |
| API 参考 / API reference | API 参考 | API reference |
| AI 开发 / AI development | AI 开发指南 | AI development |
| 常见问题 / FAQ | 常见问题 | FAQ |
| 更新日志 / Changelog | 更新日志 | Changelog |
可以直接在仓库中阅读 Markdown 文档。构建 HTML 网站需要 Python、Sphinx 依赖,以及提供网站模板和静态资源的服务器。请先将环境变量 WEB_DOCS_BUILDER_URL 设置为可访问的模板服务器地址,再运行以下命令。
You can read the Markdown files directly in this repository. Building the HTML website requires Python, the Sphinx dependencies, and a server providing the website templates and static assets. Set the WEB_DOCS_BUILDER_URL environment variable to a reachable template server before running:
python3 -m pip install -r requirements.txt
make html生成的中文和英文页面分别位于 _build/html/zh/ 和 _build/html/en/。
The generated Chinese and English pages are written to _build/html/zh/ and _build/html/en/, respectively.
发现文档问题或希望完善内容,请提交 Issue 或 Pull Request,并参考贡献指南。文档页面请使用小写英文文件名,并尽量同步更新中英文内容;仓库根目录的入口文件使用 README.md。
Report documentation issues or suggest improvements through Issues and pull requests. Read the contribution guide. Use lowercase English filenames for documentation pages and update both language versions where possible; the repository's root entry file is README.md.