fix doc link

2020-02-11 11:53:27 +08:00
parent 899e958794
commit 10082b7b9d
5 changed files with 48 additions and 24 deletions
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-
+
 ![](./doc/image/introduction/TencentOS_tiny_log.png)

 [![license](http://img.shields.io/badge/license-BSD-blue.svg)](https://github.com/Tencent/TencentOS-tiny/blob/master/LICENSE)
@@ -65,18 +65,18 @@ TencentOS tiny目前支持STM32、NXP、华大半导体、国民技术、GD32、
 欢迎IoT相关项目合作，有合作需求的请邮件联系TencentOS tiny官方工作人员，邮箱地址 ： supowang@tencent.com

 # 二、TencentOS tiny 代码目录
- [TencentOS tiny代码目录说明](./doc/09.TencentOS_tiny_code_directory_description.md)
+- [TencentOS tiny代码目录说明](./doc/09.Code_directories.md)

 # 三、TencentOS tiny 参考文档
 ## 1、移植指南
- [TencentOS tiny移植指南（KEIL版本）](./doc/10.TencentOS_tiny_porting_guide_keil.md)
- [TencentOS tiny移植指南（IAR版本）](./doc/11.TencentOS_tiny_porting_guide_iar.md)
- [TencentOS tiny移植指南（GCC版本）](./doc/12.TencentOS_tiny_porting_guide_gcc.md)
+- [TencentOS tiny移植指南（KEIL版本）](./doc/10.Porting_manual_for_keil.md)
+- [TencentOS tiny移植指南（IAR版本）](./doc/11.Porting_manual_for_iar.md)
+- [TencentOS tiny移植指南（GCC版本）](./doc/12.Porting_manual_for_gcc.md)

 ## 2、TencentOS tiny 开发指南
- [TencentOS tiny内核开发指南](./doc/04.TencentOS_tiny_Development_Guide.md)
- [TencentOS tiny API参考](./doc/05.TencentOS_tiny_SDK_documentation.md)
- [TencentOS tiny对接腾讯云IoTHub开发指南](./doc/08.The_development_Guide_for_use_TencentOS_tiny_connect_to_Tencent_Cloud_IoTHub.md)
+- [TencentOS tiny内核开发指南](./doc/04.Development_manual.md)
+- [TencentOS tiny API参考](./doc/05.SDK_manual.md)
+- [TencentOS tiny对接腾讯云IoTHub开发指南](./doc/08.QCloud_IoTHub_quick_start.md)

 # 四、TencentOS tiny 开源协议
 * TencentOS tiny 遵循 [BSD-3开源许可协议](LICENSE)
@@ -92,7 +92,7 @@ TencentOS tiny联合合作伙伴(南京厚德物联网)设计了定制开发板
 ![](./doc/image/introduction/EVB_MX.png)

 - [TencentOS tiny定制开发板介绍页](http://www.holdiot.com/product/showproduct.php?id=8)，开发者可以基于定制开发板进行快速入门学习，点击下载参考文档
- [TencentOS-tiny定制开发板入门指南](./doc/15.TencentOS_tiny_Custom_Development_Board_Getting_Started_Guide.pdf)
+- [TencentOS-tiny定制开发板入门指南](./doc/15.TencentOS_tiny_EVB_MX+_quick_start.md)

 # 七、贡献代码
 * 1.  在您自己的GitHub账户下Fork TencentOS tiny 开源项目；
--- a/README_en.md
+++ b/README_en.md
@@ -1,4 +1,4 @@
-
+
 ![](./doc/image/introduction/TencentOS_tiny_log.png)

 [![license](http://img.shields.io/badge/license-BSD-blue.svg)](https://github.com/Tencent/TencentOS-tiny/blob/master/LICENSE)
@@ -82,18 +82,18 @@ The fault scene information is automatically uploaded to the cloud platform, whi
 TencentOS tiny currently supports mainstream MCUs such as STM32, NXP, Huada Semiconductor, National Technology, GD32, Nordic, and TI. Two sets of official custom development board designs have been completed, supporting the full range of STM32 NUCLEO official evaluation board kernel migration. TencentOS tiny will work together with partners to provide better IoT terminal software solutions for IoT terminal manufacturers, facilitating the rapid access of various IoT devices to Tencent Cloud, and jointly expanding the IoT ecosystem to better support smart cities, smart water meters, and smart homes. , smart wear, car networking and other industrial applications.

 # TencentOS tiny code directory
- [TencentOS tiny code directory description](./doc/09.TencentOS_tiny_code_directory_description.md)
+- [TencentOS tiny code directory description](./doc/09.Code_directories.md)

 # TencentOS tiny reference documentation
 ## 1、Porting guide
- [TencentOS tiny Porting guide（KEIL version）](./doc/10.TencentOS_tiny_porting_guide_keil.md)
- [TencentOS tiny Porting guide（IAR version）](./doc/11.TencentOS_tiny_porting_guide_iar.md)
- [TencentOS tiny Porting guide（GCC version）](./doc/12.TencentOS_tiny_porting_guide_gcc.md)
+- [TencentOS tiny Porting guide（KEIL version）](./doc/10.Porting_manual_for_keil.md)
+- [TencentOS tiny Porting guide（IAR version）](./doc/11.Porting_manual_for_iar.md)
+- [TencentOS tiny Porting guide（GCC version）](./doc/12.Porting_manual_for_gcc.md)

 ## 2、Development guide
- [TencentOS tiny Kernel development guide](./doc/04.TencentOS_tiny_Development_Guide.md)
- [TencentOS tiny API reference](./doc/05.TencentOS_tiny_SDK_documentation.md)
- [The development Guide for use TencentOS tiny connect to  Tencent Cloud IoTHub ](./doc/08.The_development_Guide_for_use_TencentOS_tiny_connect_to_Tencent_Cloud_IoTHub.md)
+- [TencentOS tiny Kernel development guide](./doc/04.Development_manual.md)
+- [TencentOS tiny API reference](./doc/05.SDK_manual.md)
+- [The development Guide for use TencentOS tiny connect to  Tencent Cloud IoTHub ](./doc/08.QCloud_IoTHub_quick_start.md)

 # TencentOS tiny opensource license
 * TencentOS tiny follow [BSD-3 Open source license agreement](LICENSE)
@@ -109,7 +109,7 @@ TencentOS tiny joint partner (Nanjing Houde IoT) designed a custom development b
 ![](./doc/image/introduction/EVB_MX.png)

 - [TencentOS tiny custom development board introduction page](http://www.holdiot.com/product/showproduct.php?id=8) ,Developers can quickly learn based on custom development boards, click to download reference documentation
- [TencentOS-tiny Custom Development Board Getting Started Guide](./doc/15.TencentOS_tiny_Custom_Development_Board_Getting_Started_Guide.pdf)
+- [TencentOS-tiny Custom Development Board Getting Started Guide](./doc/15.TencentOS_tiny_EVB_MX+_quick_start.md)

 # Contributing
 * 1.  Fork TencentOS tiny open source project under your own GitHub account;
--- a/doc/11.Porting_manual_for__iar.md
+++ b/doc/11.Porting_manual_for__iar.md
--- a/doc/12.Porting_manual_for__gcc.md
+++ b/doc/12.Porting_manual_for__gcc.md
--- a/doc/15.TencentOS_tiny_EVB_MX+_quick_start.md
+++ b/doc/15.TencentOS_tiny_EVB_MX+_quick_start.md
@@ -34,8 +34,8 @@ EVB_MX+是腾讯物联网操作系统TencentOS tiny 团队联合南京厚德物
 在下图的TP5410电路中，VBUS为USB接口提供的电压，为总电压。BAT_VCC是锂电池充电电压，该引脚接锂电池。VOUT引脚输出+5V电压，该电压可由锂电池升压产生，供给后续电路使用。
 ![](image/EVB_MX_guide/power01.png)
 2）电源稳压电路
-锂电池电源管理电路可以将3.7V锂电池升压至5V，但这并不能直接作为电源给EVB_MX+直接供电，EVB_MX+上的元器件供电电压范围普遍在1.8V~3.6V，推荐电压均为3.3V，（BC35供电范围是：3.1V~4.2V，推荐电压3.8V，使用3.3V也可以正常工作），因此需要将5V的电平转换成3.3V供给EVB_MX+开发板使用，这里使用RT8059作为3.3V稳压器芯片。
-RT8059是一款高效率脉冲宽度降压型DC/DC转换器。输入电压2.8V~5.5V，输出电压可调范围为：0.6V~Vin，输出电流可以达到1A。在我们提供的电路中将输出调节至3.3V，让开发板正常工作。
+锂电池电源管理电路可以将3.7V锂电池升压至5V，但这并不能直接作为电源给EVB_MX+直接供电，EVB_MX+上的元器件供电电压范围普遍在1.8V-3.6V，推荐电压均为3.3V，（BC35供电范围是：3.1V-4.2V，推荐电压3.8V，使用3.3V也可以正常工作），因此需要将5V的电平转换成3.3V供给EVB_MX+开发板使用，这里使用RT8059作为3.3V稳压器芯片。
+RT8059是一款高效率脉冲宽度降压型DC/DC转换器。输入电压2.8V-5.5V，输出电压可调范围为：0.6V-Vin，输出电流可以达到1A。在我们提供的电路中将输出调节至3.3V，让开发板正常工作。
 ![](image/EVB_MX_guide/power02.png)

 #### 1.3.2  STM32最小系统电路
@@ -108,37 +108,58 @@ Keil公司开发的ARM开发工具MDK，是用来开发基于ARM核的系列微
 登录MDK官网，下载MDK5软件，下载地址：
 http://www2.keil.com/mdk5  或者 https://www.keil.com/download/product/
 下载的版本最好在5.24以上，本开发教程以5.24版本为例，双击MDK524应用程序文件，点击next>>。
+
 ![](image/EVB_MX_guide/mdk01.png)
+
 打上 I agree前面的勾勾，即是同意一些安装协议。点击next>>。
+
 ![](image/EVB_MX_guide/mdk02.png)
+
 选择安装路径，可以默认也可以安装在我们自己建立的文件夹下。点击next>>。
+
 ![](image/EVB_MX_guide/mdk03.png)
+
 这里填写的是我们的一些信息，填写完整后，继续next>>。
+
 ![](image/EVB_MX_guide/mdk04.png)
+
 然后等待安装完成即可。
+
 ![](image/EVB_MX_guide/mdk05.png)
+
 安装完成，点击Finish。
+
 ![](image/EVB_MX_guide/mdk06.png)
+
 然后会跳出来这个界面，这个我们后面再讲，先点OK，把弹框都叉掉。
+
 ![](image/EVB_MX_guide/mdk07.png)
+
 激活MDK，导入License,激活MDK后便可使用了。
+
 ![](image/EVB_MX_guide/mdk08.png)
 ![](image/EVB_MX_guide/mdk09.png)
+
 特别提示：一定要输入License激活MDK软件，建议购买正版License。

 ### 2.3 MDK安装
 安装完MDK后，我们需要安装开发套件中单片机型号对应的Pack。
-**安装方式一：**登录官网：http://www.keil.com/dd2/pack/ 
+**安装方式一**  登录官网：http://www.keil.com/dd2/pack/ 
 下载Keil.STM32L4xx_DFP.2.0.0.pack 后安装，如下图
+
 ![](image/EVB_MX_guide/mdk_pack01.png)

-**安装方式二：**MDK软件上在线安装
+**安装方式二**  MDK软件上在线安装

 打开软件，在导航栏打开Pack安装界面，然后选择ok选项。
+
 ![](image/EVB_MX_guide/mdk_pack02.png)
 ![](image/EVB_MX_guide/mdk_pack03.png)
+
 进入在线安装界面，选着STM32L4XX Pack,点击Install进行安装。
+
 ![](image/EVB_MX_guide/mdk_pack04.png)
+
 至此，我们开发板的单片机程序开发环境已经搭建完毕，重启MDK软件就可以使用了。

 ### 2.4 ST-Link驱动安装
@@ -147,6 +168,7 @@ http://www2.keil.com/mdk5  或者 https://www.keil.com/download/product/
 https://www.st.com/content/st_com/zh/products/development-tools/software-development-tools/stm32-software-development-tools/stm32-utilities/stsw-link009.html

 （驱动有2种： 32位电脑系统安装“dpinst_x86”、64位电脑系统安装“dpinst_amd64”）。 
+
 ![](./image/EVB_MX_guide/development_env_stlink_driver_file.png)

 运行对应的驱动，安装ST-Link V2驱动程序。安装路径尽量保持默认路径。
@@ -184,8 +206,10 @@ https://www.st.com/content/st_com/zh/products/development-tools/software-develop

 互联网搜索下载CH340 串口芯片的驱动
 安装方法：打开驱动安装程序点击安装即可。
+
 ![](./image/EVB_MX_guide/ch340_file.png)
 ![](./image/EVB_MX_guide/ch340_driver_install.png)
+
 注：若安装失败，请先点击卸载，后点击安装。

 ### 2.7 串口调试助手的安装与使用
@@ -243,8 +267,8 @@ https://github.com/Tencent/TencentOS-tiny
 ![](./image/EVB_MX_guide/hello_run.png)

 更多TencentOS tiny基础内核的使用，请参考内核开发指南文档：
-TencentOS_tiny\doc\04.TencentOS_tiny_Development_Guide.md
-TencentOS_tiny\doc\05.TencentOS_tiny_SDK_documentation.md
+- [TencentOS tiny内核开发指南](./doc/04.Development_manual.md)
+- [TencentOS tiny API参考](./doc/05.SDK_manual.md)

 ## 4. 使用TencentOS tiny定制开发板对接腾讯云IoT Explorer
 ### 4.1 入门概述