1. 如何贡献项目

HandsFree是一个希望推动国内机器教育的开源项目,如果你感兴趣,可以参与该Wiki的教程编写,作为社区回馈,我们会根据提交的教程水准,赠送作者机器人相关配件,书籍,雷达,摄像头,以及HandsFree机器人平台等。

只要提交教程就有礼品喔~。

1.1. 概述

本wiki以Gitbook的形式编写,源文件存储于: https://github.com/mawenke/handsfree_wiki

特殊目录介绍

  • docs 目录用于存放md文件
  • images 目录用于存放md引用的图片
  • docs/Tutorial/ 目录用于存放机器人的开发实验教程,主要是基于ROS.
  • docs/Tutorial/Advanced 下的教程独立性比较高,且一般是由各路大神补充的教程,所以图片和md文件放在同目录
  • docs/Courses 目录用于存放机器人教育的相关学习教程.
  • docs/Courses/Advanced 下的教程独立性比较高,且一般是由各路大神补充的教程,所以图片和md文件放在同目录

1.2. 如何贡献文档

  1. 在Github上fork 作者的HandsFree Wiki源文件: https://github.com/mawenke/handsfree_wiki
  2. 在自己的本地仓库上编辑更改文档后用Github 的Pull Requests功能提交自己的更新给作者的仓库

1.3. 语法和排版规范

  1. 使用GitHub支持的Markdown语言,可参考HandsFree的 markdown 教程
  2. 一个小节从大标题开始,到三标题会自动生成悬浮目录,标题不能是链接或者图片
  3. 标题不需要标注1,2,3...等序号,序号由插件自动生成
  4. 正文前不需要空格
  5. 图片和本地文件的引用,请用相对链接
  6. 图片全部用.jpg格式,vedio使用.mp4格式,GIF需要压缩竟可能小于3M

本开源书籍遵循 中文排版指南 规范。

1.4. 排版模板

# 如何贡献项目  
//本小节大标题,从大标题开始到三标题会自动生成悬浮目录,标题不能是链接或者图片
//标题不需要标注1,2,3...等序号,序号由插件自动生成
//正文前不需要空格
HandsFree是一个希望推动国内机器教育的开源项目,如果你感兴趣,可以参与该Wiki的教程编写,作为社区回馈,我们会根据提交的教程水准,赠送作者机器人相关配件,书籍,雷达,摄像头,以及HandsFree机器人平台等。 

> 只要提交教程就有礼品喔~。

## 概述  
// 本小节二标题,标题不需要标注序号

本wiki以[Gitbook](https://www.gitbook.com)的形式编写,源文件存储于: [https://github.com/mawenke/handsfree_wiki](https://github.com/mawenke/handsfree_wiki)

特殊目录介绍
* docs 目录用于存放md文件
* images 目录用于存放md引用的图片
* docs/Tutorial/ 目录用于存放机器人的开发实验教程,主要是基于ROS.
* docs/Tutorial/Advanced 下的教程独立性比较高,且一般是由各路大神补充的教程,所以图片和md文件放在同目录
* docs/Courses 目录用于存放机器人教育的相关学习教程.
* docs/Courses/Advanced 下的教程独立性比较高,且一般是由各路大神补充的教程,所以图片和md文件放在同目录
Copyright © 深圳朝闻道智能信息科技有限公司 2018 all right reserved,powered by Gitbook该文件修订时间: 2018-09-06 21:44:37

results matching ""

    No results matching ""