sota method of mapping and localization 下面是一个较为规范、友好、清晰的Github项目说明范例。示例项目名称为 Solaris
这里为介绍 Solaris 项目的文字描述。
- 特性1,简要描述。
- 特性2,简要描述。
- 特性3,简要描述。
配图
简要介绍哪些机构或项目正在使用我们这个项目。
- 项目1(可以是一个github 项目链接)
- 项目2
- ...
- 使用数字列表按顺序描述。
- 描述...
- ...
对于使用场景1的描述。
对于使用场景2的描述。
如果需要安装,详细描述安装步骤。
如果有必要,使用数字列表分步说明:
- 首先...
- 其次...
- ...
关于配置的描述。
如果需要用到代码片段
"config":{
"path": "/"
}
继续说明。
"config":{
"name": "index.html"
}
针对配置项的详细说明:
- path: 这里是说明。
- name: 这里是说明。
- ...
如果Solaris项目接受贡献,请说明方式。
如果Solaris项目有捐赠信息,可以说明。
简要说明Solaris项目使用何种License授权。
这里使用无序列表放一些外部链接。