MaixPy_DOC 实例教程模板

    本文说明文档贡献者在撰写教程中遵循的规范,以及注意事项,请各位贡献者根据本文撰写文档;
    如果对模板格式,内容存在疑惑请到本项目仓库 MaixPy_DOC 提交 ISSUE

    🙇‍ 感谢各位贡献者的热心支持!

    • 关于文档编写工具

    文档使用 MarkDown 语法撰写, 整体文档项目使用 gitbook 构建;这里推荐使用 TyporaVS Code 搭配 MarkDown 插件作为文本编辑器

    • 关于文档图文内容存放

    实例教程文档请存放到路径 ./MaixPy_DOC/zh(这里区分中英文,中文:zh,英文:en)/application/xxx(具体分类,分类建议请看后续描述)/xxx(具体的例程名称,建议使用英文命名).md

    文档中引用到的图片建议使用相对链接,并将图片文件存放与文档同目录下的 [文件名].assets 文件夹中;

    • 关于文档分类建立存放路径

    与硬件外设强相关的建议命名(存放路径)为:``

    与 image 强相关的建议命名(存放路径)为:image

    与 KPU 强相关的建议命名(存放路径)为:KPU

    较为综合的例程的建议命名(存放路径)为:demo

    以下内容为文档模板内容:

    MaixPy 实例教程 —— XXX

    一、概述:

    1. 描述下该例程实现的效果

    2. 简要说明操作步骤

    二、准备:

    说明需要准备的软硬件环境

    • 预备知识

    • 硬件

      图文描述使用到的开发板&&外设模块等

    • 软件

      图文描述使用到的软件工具,MaixPy 版本
      如果使用到第三方软件工具,可以附加相关名称或下载链接

    具体操作步骤

    程序代码

    xxxxx
    

    效果

    建议添加图片展示实际运行效果

    问题和反馈(Question && Feedback)


    • 贡献者说明:

    这里给贡献者提供引流入口

    作者:
    
    联系方式(Email):
    
    博客: