From 72869fad1dcb20c52ea324e3268094aaf3192328 Mon Sep 17 00:00:00 2001 From: supowang Date: Thu, 21 Nov 2019 10:28:52 +0800 Subject: [PATCH] rename doc and update ReadMe --- README.md | 16 ++++++++-------- README_en.md | 14 +++++++------- .../1.TencentOS_tiny_Product_Brief.md | 0 ... => 10.TencentOS_tiny_porting_guide_keil.md} | 0 ...d => 11.TencentOS_tiny_porting_guide_iar.md} | 0 ...d => 12.TencentOS_tiny_porting_guide_gcc.md} | 0 ...ncentOS_tiny_porting(MacOS_STM32CubeIDE).md} | 0 ...ld_RISC-V_eclipse_development_environment.md | 0 ..._Development_Board_Getting_Started_Guide.pdf | Bin ...encentOS_tiny_Purchase_Guide_Free_Edition.md | 0 .../3.TencentOS_tiny_Quick_Start.md | 0 .../4.TencentOS_tiny_Development_Guide.md | 0 .../5.TencentOS_tiny_SDK_documentation.md | 0 .../6.TencentOS_tiny_FAQ.md | 0 .../7.TencentOS_tiny_glossary.md | 0 ...ntOS_tiny_connect_to_Tencent_Cloud_IoTHub.md | 0 ...TencentOS_tiny_code_directory_description.md | 0 17 files changed, 15 insertions(+), 15 deletions(-) rename "doc/1. TencentOS tiny \344\272\247\345\223\201\347\256\200\344\273\213.md" => doc/1.TencentOS_tiny_Product_Brief.md (100%) rename doc/{TencentOS tiny porting guide keil.md => 10.TencentOS_tiny_porting_guide_keil.md} (100%) rename doc/{TencentOS tiny porting guide iar.md => 11.TencentOS_tiny_porting_guide_iar.md} (100%) rename doc/{TencentOS tiny porting guide gcc.md => 12.TencentOS_tiny_porting_guide_gcc.md} (100%) rename doc/{TencentOS tiny porting(MacOS_STM32CubeIDE).md => 13.TencentOS_tiny_porting(MacOS_STM32CubeIDE).md} (100%) rename "doc/RISC-V eclipse \345\274\200\345\217\221\347\216\257\345\242\203\346\220\255\345\273\272.md" => doc/14.How_to_build_RISC-V_eclipse_development_environment.md (100%) rename "doc/TencentOS tiny \345\256\232\345\210\266\345\274\200\345\217\221\346\235\277\345\205\245\351\227\250\346\214\207\345\215\227.pdf" => doc/15.TencentOS_tiny_Custom_Development_Board_Getting_Started_Guide.pdf (100%) rename "doc/2. TencentOS tiny \350\264\255\344\271\260\346\214\207\345\215\227_\345\205\215\350\264\271\347\211\210.md" => doc/2.TencentOS_tiny_Purchase_Guide_Free_Edition.md (100%) rename "doc/3. TencentOS tiny \345\277\253\351\200\237\345\205\245\351\227\250.md" => doc/3.TencentOS_tiny_Quick_Start.md (100%) rename "doc/4. TencentOS tiny \345\274\200\345\217\221\346\214\207\345\215\227.md" => doc/4.TencentOS_tiny_Development_Guide.md (100%) rename "doc/5. TencentOS tiny SDK\346\226\207\346\241\243.md" => doc/5.TencentOS_tiny_SDK_documentation.md (100%) rename "doc/6. TencentOS tiny \345\270\270\350\247\201\351\227\256\351\242\230.md" => doc/6.TencentOS_tiny_FAQ.md (100%) rename "doc/7. TencentOS tiny \350\257\215\346\261\207\350\241\250.md" => doc/7.TencentOS_tiny_glossary.md (100%) rename "doc/8. TencentOS tiny \345\257\271\346\216\245\350\205\276\350\256\257\344\272\221IoTHub\345\274\200\345\217\221\346\214\207\345\215\227.md" => doc/8.The_development_Guide_for_use_TencentOS_tiny_connect_to_Tencent_Cloud_IoTHub.md (100%) rename "doc/TencentOS tiny \344\273\243\347\240\201\347\233\256\345\275\225\350\257\264\346\230\216.md" => doc/9.TencentOS_tiny_code_directory_description.md (100%) diff --git a/README.md b/README.md index e3392b75..11340ded 100644 --- a/README.md +++ b/README.md @@ -65,18 +65,18 @@ TencentOS tiny目前支持STM32、NXP、华大半导体、国民技术、GD32、 欢迎IoT相关项目合作，有合作需求的请邮件联系TencentOS tiny官方工作人员，邮箱地址 ： supowang@tencent.com # 二、TencentOS tiny 代码目录 -- [TencentOS tiny代码目录说明](./doc/TencentOS tiny 代码目录说明.md) +- [TencentOS tiny代码目录说明](./doc/9.TencentOS_tiny_code_directory_description.md) # 三、TencentOS tiny 参考文档 ## 1、移植指南 -- [TencentOS tiny移植指南（KEIL版本）](./doc/TencentOS tiny porting guide keil.md) -- [TencentOS tiny移植指南（IAR版本）](./doc/TencentOS tiny porting guide iar.md) -- [TencentOS tiny移植指南（GCC版本）](./doc/TencentOS tiny porting guide gcc.md) +- [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) ## 2、TencentOS tiny 开发指南 -- [TencentOS tiny内核开发指南](./doc/4. TencentOS tiny 开发指南.md) -- [TencentOS tiny API参考](./doc/5. TencentOS tiny SDK文档.md) -- [TencentOS tiny对接腾讯云IoTHub开发指南](./doc/8. TencentOS tiny 对接腾讯云IoTHub开发指南.md) +- [TencentOS tiny内核开发指南](./doc/4.TencentOS_tiny_Development_Guide.md) +- [TencentOS tiny API参考](./doc/5.TencentOS_tiny_SDK_documentation.md) +- [TencentOS tiny对接腾讯云IoTHub开发指南](./doc/8.The_development_Guide_for_use_TencentOS_tiny_connect_to_Tencent_Cloud_IoTHub.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/TencentOS-tiny定制开发板入门指南.pdf) +- [TencentOS-tiny定制开发板入门指南](./doc/15.TencentOS_tiny_Custom_Development_Board_Getting_Started_Guide.pdf) # 七、贡献代码 * 1. 在您自己的GitHub账户下Fork TencentOS tiny 开源项目； diff --git a/README_en.md b/README_en.md index de87473f..dec89d47 100644 --- a/README_en.md +++ b/README_en.md @@ -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/TencentOS tiny 代码目录说明.md) +- [TencentOS tiny code directory description](./doc/9.TencentOS_tiny_code_directory_description.md) # TencentOS tiny reference documentation ## 1、Porting guide -- [TencentOS tiny Porting guide（KEIL version）](./doc/TencentOS tiny porting guide keil.md) -- [TencentOS tiny Porting guide（IAR version）](./doc/TencentOS tiny porting guide iar.md) -- [TencentOS tiny Porting guide（GCC version）](./doc/TencentOS tiny porting guide gcc.md) +- [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) ## 2、Development guide -- [TencentOS tiny Kernel development guide](./doc/4. TencentOS tiny 开发指南.md) -- [TencentOS tiny API reference](./doc/5. TencentOS tiny SDK文档.md) -- [The development Guide for use TencentOS tiny access to Tencent Cloud IoTHub ](./doc/8. TencentOS tiny 对接腾讯云IoTHub开发指南.md) +- [TencentOS tiny Kernel development guide](./doc/4.TencentOS_tiny_Development_Guide.md) +- [TencentOS tiny API reference](./doc/5.TencentOS_tiny_SDK_documentation.md) +- [The development Guide for use TencentOS tiny connect to Tencent Cloud IoTHub ](./doc/8.The_development_Guide_for_use_TencentOS_tiny_connect_to_Tencent_Cloud_IoTHub.md) # TencentOS tiny opensource license * TencentOS tiny follow [BSD-3 Open source license agreement](LICENSE) diff --git "a/doc/1. TencentOS tiny \344\272\247\345\223\201\347\256\200\344\273\213.md" b/doc/1.TencentOS_tiny_Product_Brief.md similarity index 100% rename from "doc/1. TencentOS tiny \344\272\247\345\223\201\347\256\200\344\273\213.md" rename to doc/1.TencentOS_tiny_Product_Brief.md diff --git a/doc/TencentOS tiny porting guide keil.md b/doc/10.TencentOS_tiny_porting_guide_keil.md similarity index 100% rename from doc/TencentOS tiny porting guide keil.md rename to doc/10.TencentOS_tiny_porting_guide_keil.md diff --git a/doc/TencentOS tiny porting guide iar.md b/doc/11.TencentOS_tiny_porting_guide_iar.md similarity index 100% rename from doc/TencentOS tiny porting guide iar.md rename to doc/11.TencentOS_tiny_porting_guide_iar.md diff --git a/doc/TencentOS tiny porting guide gcc.md b/doc/12.TencentOS_tiny_porting_guide_gcc.md similarity index 100% rename from doc/TencentOS tiny porting guide gcc.md rename to doc/12.TencentOS_tiny_porting_guide_gcc.md diff --git a/doc/TencentOS tiny porting(MacOS_STM32CubeIDE).md b/doc/13.TencentOS_tiny_porting(MacOS_STM32CubeIDE).md similarity index 100% rename from doc/TencentOS tiny porting(MacOS_STM32CubeIDE).md rename to doc/13.TencentOS_tiny_porting(MacOS_STM32CubeIDE).md diff --git "a/doc/RISC-V eclipse \345\274\200\345\217\221\347\216\257\345\242\203\346\220\255\345\273\272.md" b/doc/14.How_to_build_RISC-V_eclipse_development_environment.md similarity index 100% rename from "doc/RISC-V eclipse \345\274\200\345\217\221\347\216\257\345\242\203\346\220\255\345\273\272.md" rename to doc/14.How_to_build_RISC-V_eclipse_development_environment.md diff --git "a/doc/TencentOS tiny \345\256\232\345\210\266\345\274\200\345\217\221\346\235\277\345\205\245\351\227\250\346\214\207\345\215\227.pdf" b/doc/15.TencentOS_tiny_Custom_Development_Board_Getting_Started_Guide.pdf similarity index 100% rename from "doc/TencentOS tiny \345\256\232\345\210\266\345\274\200\345\217\221\346\235\277\345\205\245\351\227\250\346\214\207\345\215\227.pdf" rename to doc/15.TencentOS_tiny_Custom_Development_Board_Getting_Started_Guide.pdf diff --git "a/doc/2. TencentOS tiny \350\264\255\344\271\260\346\214\207\345\215\227_\345\205\215\350\264\271\347\211\210.md" b/doc/2.TencentOS_tiny_Purchase_Guide_Free_Edition.md similarity index 100% rename from "doc/2. TencentOS tiny \350\264\255\344\271\260\346\214\207\345\215\227_\345\205\215\350\264\271\347\211\210.md" rename to doc/2.TencentOS_tiny_Purchase_Guide_Free_Edition.md diff --git "a/doc/3. TencentOS tiny \345\277\253\351\200\237\345\205\245\351\227\250.md" b/doc/3.TencentOS_tiny_Quick_Start.md similarity index 100% rename from "doc/3. TencentOS tiny \345\277\253\351\200\237\345\205\245\351\227\250.md" rename to doc/3.TencentOS_tiny_Quick_Start.md diff --git "a/doc/4. TencentOS tiny \345\274\200\345\217\221\346\214\207\345\215\227.md" b/doc/4.TencentOS_tiny_Development_Guide.md similarity index 100% rename from "doc/4. TencentOS tiny \345\274\200\345\217\221\346\214\207\345\215\227.md" rename to doc/4.TencentOS_tiny_Development_Guide.md diff --git "a/doc/5. TencentOS tiny SDK\346\226\207\346\241\243.md" b/doc/5.TencentOS_tiny_SDK_documentation.md similarity index 100% rename from "doc/5. TencentOS tiny SDK\346\226\207\346\241\243.md" rename to doc/5.TencentOS_tiny_SDK_documentation.md diff --git "a/doc/6. TencentOS tiny \345\270\270\350\247\201\351\227\256\351\242\230.md" b/doc/6.TencentOS_tiny_FAQ.md similarity index 100% rename from "doc/6. TencentOS tiny \345\270\270\350\247\201\351\227\256\351\242\230.md" rename to doc/6.TencentOS_tiny_FAQ.md diff --git "a/doc/7. TencentOS tiny \350\257\215\346\261\207\350\241\250.md" b/doc/7.TencentOS_tiny_glossary.md similarity index 100% rename from "doc/7. TencentOS tiny \350\257\215\346\261\207\350\241\250.md" rename to doc/7.TencentOS_tiny_glossary.md diff --git "a/doc/8. TencentOS tiny \345\257\271\346\216\245\350\205\276\350\256\257\344\272\221IoTHub\345\274\200\345\217\221\346\214\207\345\215\227.md" b/doc/8.The_development_Guide_for_use_TencentOS_tiny_connect_to_Tencent_Cloud_IoTHub.md similarity index 100% rename from "doc/8. TencentOS tiny \345\257\271\346\216\245\350\205\276\350\256\257\344\272\221IoTHub\345\274\200\345\217\221\346\214\207\345\215\227.md" rename to doc/8.The_development_Guide_for_use_TencentOS_tiny_connect_to_Tencent_Cloud_IoTHub.md diff --git "a/doc/TencentOS tiny \344\273\243\347\240\201\347\233\256\345\275\225\350\257\264\346\230\216.md" b/doc/9.TencentOS_tiny_code_directory_description.md similarity index 100% rename from "doc/TencentOS tiny \344\273\243\347\240\201\347\233\256\345\275\225\350\257\264\346\230\216.md" rename to doc/9.TencentOS_tiny_code_directory_description.md -- GitLab