生成git降价toc的工具
git-toc的Python项目详细描述
#目录
*[说明](说明)
*[依赖项](依赖项)
*[示例用法](示例用法)
*[从PYPI安装(首选)](从PYPI安装首选)
*[从源安装](从源安装)
*[用法](用法)
*[示例](示例)
说明
为[Github标记语言](https://guides.github.com/features/mastering-markdown/)文档生成超级简单的TOC(内容表)。
依赖关系
*Python2.7。
*``pip``用于安装过程。
示例用法
```
$gittoc-f readme.md
```
```
*[绿茶客户](绿茶客户)
*[MBED驱动程序依赖项](MBED驱动程序依赖项)
*[绿茶测试工具](绿茶测试工具)
*[兼容性](兼容性)
*[绿茶支持](绿茶支持)
*[最新支持](最新支持)
*[模块中的绿茶客户端支持](模块中的绿茶客户端支持)
*[条款](条款)
*[测试套件](测试套件)
*[测试用例](测试用例)
*[密钥值协议](密钥值协议)
*[在哪里可以使用?](where-can-i-use-it)
*[测试套件模型](测试套件模型)
*[utest支持模板](utest支持模板)
*[无UTEST支持模板](无UTEST支持模板)
```
从PYPI安装(首选)
此应用程序随pypi一起发布,因此您可以使用“pip”将其安装到主机上。
```
$pip install git toc--升级
```
从源安装
```
$git克隆https://github.com/przemekwirkus/git-toc.git
```
```
$cd git目录
$python setup.py安装
```
用法
下面的命令将在屏幕上打印从开关``-f``指定的文件中提取的TOC,您可以将其嵌入到``readme.md``文档的TOC部分。
```
$gittoc-f<;文件名>;
```
示例
```
$gittoc.exe-f testing.md
```
```
*[mbed-sdk自动测试套件](mbed-sdk自动测试套件)
*[简介](简介)
*[什么是主机测试?](什么是主机测试)
*[测试套件核心:singletest.py脚本](测试套件核心singletestpy脚本)
*[singletest.py的参数](singletestpy的参数)
*[MUTS规范](MUTS规范)
*[外设测试](外设测试)
*[附加MUTS配置文件设置](附加MUTS配置文件设置)
*[运行测试](运行测试)
*[设备配置示例(一个设备连接到主机)](设备配置示例一个设备连接到主机)
*[cpputest单元测试库支持](cpputest单元测试库支持)
*[mbed-sdk测试介绍中的cpputest](《mbed-sdk测试介绍中的cpputest》)
*[从中可以获得有关cpputest库和单元测试的更多帮助](从中可以获得有关cpputest库和单元测试的更多帮助)
*[如何将cpputest添加到当前mbed sdk安装](如何将cpputest添加到当前mbed sdk安装)
*[是否需要MBED sdk的cpputest端口?](do-i-need-cpputest-port-for-mbed-sdk)
*[先决条件](先决条件)
*[如何/在何处安装](如何-在何处安装)
*[支持cpputest的离线mbed-sdk项目](支持cpputest的离线mbed-sdk项目)
*[cpputest with mbed port](cpputest with mbed port-)
*[单元测试位置](单元测试位置)
*[在mbed-sdk测试套件结构中定义单元测试](在mbed-sdk测试套件结构中定义单元测试)
*[测试现在分为两种类型:](测试现在分为两种类型)
*[“hello world”测试](“hello world”测试-)
*[“单元测试”测试用例](单元测试用例)
*[示例](示例)
*[示例配置](示例配置)
*[执行测试](执行测试)
```
*[说明](说明)
*[依赖项](依赖项)
*[示例用法](示例用法)
*[从PYPI安装(首选)](从PYPI安装首选)
*[从源安装](从源安装)
*[用法](用法)
*[示例](示例)
说明
为[Github标记语言](https://guides.github.com/features/mastering-markdown/)文档生成超级简单的TOC(内容表)。
依赖关系
*Python2.7。
*``pip``用于安装过程。
示例用法
```
$gittoc-f readme.md
```
```
*[绿茶客户](绿茶客户)
*[MBED驱动程序依赖项](MBED驱动程序依赖项)
*[绿茶测试工具](绿茶测试工具)
*[兼容性](兼容性)
*[绿茶支持](绿茶支持)
*[最新支持](最新支持)
*[模块中的绿茶客户端支持](模块中的绿茶客户端支持)
*[条款](条款)
*[测试套件](测试套件)
*[测试用例](测试用例)
*[密钥值协议](密钥值协议)
*[在哪里可以使用?](where-can-i-use-it)
*[测试套件模型](测试套件模型)
*[utest支持模板](utest支持模板)
*[无UTEST支持模板](无UTEST支持模板)
```
从PYPI安装(首选)
此应用程序随pypi一起发布,因此您可以使用“pip”将其安装到主机上。
```
$pip install git toc--升级
```
从源安装
```
$git克隆https://github.com/przemekwirkus/git-toc.git
```
```
$cd git目录
$python setup.py安装
```
用法
下面的命令将在屏幕上打印从开关``-f``指定的文件中提取的TOC,您可以将其嵌入到``readme.md``文档的TOC部分。
```
$gittoc-f<;文件名>;
```
示例
```
$gittoc.exe-f testing.md
```
```
*[mbed-sdk自动测试套件](mbed-sdk自动测试套件)
*[简介](简介)
*[什么是主机测试?](什么是主机测试)
*[测试套件核心:singletest.py脚本](测试套件核心singletestpy脚本)
*[singletest.py的参数](singletestpy的参数)
*[MUTS规范](MUTS规范)
*[外设测试](外设测试)
*[附加MUTS配置文件设置](附加MUTS配置文件设置)
*[运行测试](运行测试)
*[设备配置示例(一个设备连接到主机)](设备配置示例一个设备连接到主机)
*[cpputest单元测试库支持](cpputest单元测试库支持)
*[mbed-sdk测试介绍中的cpputest](《mbed-sdk测试介绍中的cpputest》)
*[从中可以获得有关cpputest库和单元测试的更多帮助](从中可以获得有关cpputest库和单元测试的更多帮助)
*[如何将cpputest添加到当前mbed sdk安装](如何将cpputest添加到当前mbed sdk安装)
*[是否需要MBED sdk的cpputest端口?](do-i-need-cpputest-port-for-mbed-sdk)
*[先决条件](先决条件)
*[如何/在何处安装](如何-在何处安装)
*[支持cpputest的离线mbed-sdk项目](支持cpputest的离线mbed-sdk项目)
*[cpputest with mbed port](cpputest with mbed port-)
*[单元测试位置](单元测试位置)
*[在mbed-sdk测试套件结构中定义单元测试](在mbed-sdk测试套件结构中定义单元测试)
*[测试现在分为两种类型:](测试现在分为两种类型)
*[“hello world”测试](“hello world”测试-)
*[“单元测试”测试用例](单元测试用例)
*[示例](示例)
*[示例配置](示例配置)
*[执行测试](执行测试)
```