From 543e2c59d058c491e0ac0a8704cfeb90a373fe49 Mon Sep 17 00:00:00 2001 From: Donggang Cao Date: Sat, 24 Oct 2020 16:59:49 +0800 Subject: [PATCH] update directory structure --- docs/.vuepress/config.js | 22 +++++++++--- docs/.vuepress/sidebar.js | 34 ++++++++++--------- docs/doc/api.md | 1 - docs/doc/appdev.md | 1 - docs/doc/appdev/README.md | 7 ++++ docs/doc/{constructenv => appdev}/debug.md | 4 +-- .../goujian.md => appdev/dev.md} | 4 +-- .../{constructenv/bianyi.md => appdev/env.md} | 2 +- docs/doc/communication/4G.md | 6 ++-- docs/doc/communication/README.md | 26 ++++++++++++++ docs/doc/driver.md | 1 - docs/doc/hwsupport/README.md | 17 ++++++++++ docs/doc/kernel/README.md | 10 ++++++ docs/doc/sensor/README.md | 18 ++++++++++ 14 files changed, 122 insertions(+), 31 deletions(-) delete mode 100644 docs/doc/api.md delete mode 100644 docs/doc/appdev.md create mode 100644 docs/doc/appdev/README.md rename docs/doc/{constructenv => appdev}/debug.md (98%) rename docs/doc/{constructenv/goujian.md => appdev/dev.md} (99%) rename docs/doc/{constructenv/bianyi.md => appdev/env.md} (99%) create mode 100644 docs/doc/communication/README.md delete mode 100644 docs/doc/driver.md create mode 100644 docs/doc/hwsupport/README.md create mode 100644 docs/doc/kernel/README.md create mode 100644 docs/doc/sensor/README.md diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 493971c..9c95f59 100755 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -45,15 +45,23 @@ module.exports = { }, { text: '内核', - link: '/doc/kernel.html', + link: '/doc/kernel/', }, { - text: '驱动', - link: '/doc/driver.html', + text: '硬件支持', + link: '/doc/hwsupport/', + }, + { + text: '通信协议', + link: '/doc/communication/', + }, + { + text: '传感器', + link: '/doc/sensor/', }, { text: '应用开发', - link: '/doc/appdev.html', + link: '/doc/appdev/', } ] }, @@ -99,7 +107,7 @@ module.exports = { }, { title: '硬件支持', - children: getSidebarByCategory('framework','en') + children: getSidebarByCategory('hwsupport','en') }, { title: '通信协议', @@ -108,6 +116,10 @@ module.exports = { { title: '传感器', children: getSidebarByCategory('sensor','en') + }, + { + title: '应用开发', + children: getSidebarByCategory('appdev','en') } ], } diff --git a/docs/.vuepress/sidebar.js b/docs/.vuepress/sidebar.js index dd32f88..f02be33 100755 --- a/docs/.vuepress/sidebar.js +++ b/docs/.vuepress/sidebar.js @@ -1,23 +1,20 @@ const sidebar = { - 'intro': [ + 'intro': [ '/doc/intro', - '/doc/constructenv/bianyi', - '/doc/constructenv/debug', - '/doc/constructenv/goujian' ], 'kernel': [ - '/doc/kernel/mm', - '/doc/kernel/task', - '/doc/kernel/synchron', - '/doc/kernel/threadcommunication' + '/doc/kernel/mm', + '/doc/kernel/task', + '/doc/kernel/synchron', + '/doc/kernel/threadcommunication' ], - 'framework': [ - '/doc/hwsupport/aiit-arm32', - '/doc/hwsupport/stm32f407-st-discovery', - '/doc/hwsupport/stm32f407zgt6', - '/doc/hwsupport/hifive1-rev', - '/doc/hwsupport/maxgo', - '/doc/hwsupport/kd233' + 'hwsupport': [ + '/doc/hwsupport/aiit-arm32', + '/doc/hwsupport/stm32f407-st-discovery', + '/doc/hwsupport/stm32f407zgt6', + '/doc/hwsupport/hifive1-rev', + '/doc/hwsupport/maxgo', + '/doc/hwsupport/kd233' ], 'communication': [ '/doc/communication/4G', @@ -42,6 +39,11 @@ const sidebar = { '/doc/sensor/photoelec_sensor', '/doc/sensor/pressure_sensor', '/doc/sensor/voice_sensor' + ], + 'appdev': [ + '/doc/appdev/env', + '/doc/appdev/debug', + '/doc/appdev/dev' ] } @@ -58,4 +60,4 @@ function getSidebarByCategory(category, lang = 'en') { module.exports = { getSidebarByCategory -} \ No newline at end of file +} diff --git a/docs/doc/api.md b/docs/doc/api.md deleted file mode 100644 index 5932792..0000000 --- a/docs/doc/api.md +++ /dev/null @@ -1 +0,0 @@ -# API diff --git a/docs/doc/appdev.md b/docs/doc/appdev.md deleted file mode 100644 index 7d28a52..0000000 --- a/docs/doc/appdev.md +++ /dev/null @@ -1 +0,0 @@ -# 应用开发 diff --git a/docs/doc/appdev/README.md b/docs/doc/appdev/README.md new file mode 100644 index 0000000..1b3d011 --- /dev/null +++ b/docs/doc/appdev/README.md @@ -0,0 +1,7 @@ +# 应用开发 + +* [开发环境](/doc/appdev/env) + +* [调试工具](/doc/appdev/debug) + +* [开发过程](/doc/appdev/dev) diff --git a/docs/doc/constructenv/debug.md b/docs/doc/appdev/debug.md similarity index 98% rename from docs/doc/constructenv/debug.md rename to docs/doc/appdev/debug.md index d10af66..d0b59d9 100755 --- a/docs/doc/constructenv/debug.md +++ b/docs/doc/appdev/debug.md @@ -1,4 +1,4 @@ -# 编译步骤 +# 用Jlink调试 ## 前言 @@ -84,4 +84,4 @@ display: table-cell; text-align: center; } - \ No newline at end of file + diff --git a/docs/doc/constructenv/goujian.md b/docs/doc/appdev/dev.md similarity index 99% rename from docs/doc/constructenv/goujian.md rename to docs/doc/appdev/dev.md index 31c757b..fe2e6fe 100755 --- a/docs/doc/constructenv/goujian.md +++ b/docs/doc/appdev/dev.md @@ -1,4 +1,4 @@ -# 编译步骤 +# 开发步骤 ## 前言

本文档将介绍XiUOS分别在基于ARM和RISC-V架构的开发板上的编译、烧录和运行的过程。包括开发板选择及配置初始化、编译命令等信息。 @@ -53,4 +53,4 @@ + XiUOS运行在RISC-V开发板 -## FAQ \ No newline at end of file +## FAQ diff --git a/docs/doc/constructenv/bianyi.md b/docs/doc/appdev/env.md similarity index 99% rename from docs/doc/constructenv/bianyi.md rename to docs/doc/appdev/env.md index 02293ba..b30a2f2 100755 --- a/docs/doc/constructenv/bianyi.md +++ b/docs/doc/appdev/env.md @@ -1,4 +1,4 @@ -# 编译环境 +# 开发环境 ## 前言

本文档将介绍如何在个人pc设备上构建编译环境来编译 XiUOS diff --git a/docs/doc/communication/4G.md b/docs/doc/communication/4G.md index af94194..a7f81f7 100644 --- a/docs/doc/communication/4G.md +++ b/docs/doc/communication/4G.md @@ -24,7 +24,9 @@
-产品描述：EC20 Mini PCIe内嵌丰富的网络协议，集成多个工业标准接口，并支持多种软件功能(Windows XP, Windows Vista, Windows 7/8/8.1/10, Windows CE, Linux 和 Android 系统下的USB驱动,eCall*等)，极大地拓展了其在M2M 领域的应用范围，如CPE、路由器、数据卡、平板电脑、车载、安防以及工业级PDA等

+ +产品描述：EC20 Mini PCIe内嵌丰富的网络协议，集成多个工业标准接口，并支持多种软件功能(Windows XP, Windows Vista, Windows 7/8/8.1/10, Windows CE, Linux 和 Android 系统下的USB驱动,eCall\*等)，极大地拓展了其在M2M 领域的应用范围，如CPE、路由器、数据卡、平板电脑、车载、安防以及工业级PDA等

+ EC20 Mini PCIe是采用 PCI Express® Mini Card标准接口的LTE模块；采用LTE 3GPP Rel.9技术，支持最大下行速率100Mbps和最大上行速率50Mbps。EC20 Mini PCIe系列模块包含EC20-E Mini PCIe、EC20-A Mini PCIe和EC20-C Mini PCIe三个版本，使其能够向后兼容现存的EDGE和GSM/GPRS网络，以确保在缺乏3G和4G网络的偏远地区也能正常工作。

@@ -255,4 +257,4 @@ EC200T 内置丰富的网络协议，集成多个工业标准接口，并支持         (1024) The maximum length of receive line buffer ---> （缓存大小，建议在1K以上）

ec20_CodeTree -
\ No newline at end of file + diff --git a/docs/doc/communication/README.md b/docs/doc/communication/README.md new file mode 100644 index 0000000..34cd99f --- /dev/null +++ b/docs/doc/communication/README.md @@ -0,0 +1,26 @@ +# 通信协议 + +- [4G](/doc/communication/4G) + +- [5G](/doc/communication/5G) + +- [at](/doc/communication/at) + +- [Bluetooth](/doc/communication/Bluetooth) + +- [CAN](/doc/communication/CAN) + +- [Ethernet](/doc/communication/ethernet) + +- [LoRa](/doc/communication/LORA) + +- [MQTT](/doc/communication/mymqtt) + +- [NB-IOT](/doc/communication/NB-IOT) + +- [rs485](/doc/communication/rs485) + +- [WiFi](/doc/communication/WiFi) + +- [Zibgee](/doc/communication/Zigbee) + diff --git a/docs/doc/driver.md b/docs/doc/driver.md deleted file mode 100644 index dd94d13..0000000 --- a/docs/doc/driver.md +++ /dev/null @@ -1 +0,0 @@ -# 驱动 diff --git a/docs/doc/hwsupport/README.md b/docs/doc/hwsupport/README.md new file mode 100644 index 0000000..56944e1 --- /dev/null +++ b/docs/doc/hwsupport/README.md @@ -0,0 +1,17 @@ +# 硬件支持 + +## ARM + +* [aiit-arm32](/doc/hwsupport/aiit-arm32) + +* [stm32f407-st-discovery](/doc/hwsupport/stm32f407-st-discovery) + +* [stm32f407zgt6](/doc/hwsupport/stm32f407zgt6) + +## RISC-V + +* [hifive1-re](/doc/hwsupport/hifive1-rev) + +* [maxgo](/doc/hwsupport/maxg) + +* [kd233](/doc/hwsupport/kd233) diff --git a/docs/doc/kernel/README.md b/docs/doc/kernel/README.md new file mode 100644 index 0000000..5423945 --- /dev/null +++ b/docs/doc/kernel/README.md @@ -0,0 +1,10 @@ +# 内核 + +- [内存管理](/doc/kernel/mm) + +- [线程管理](/doc/kernel/task) + +- [资源管理](/doc/kernel/synchron) + +- [线程间通信](/doc/kernel/threadcommunication) + diff --git a/docs/doc/sensor/README.md b/docs/doc/sensor/README.md new file mode 100644 index 0000000..add11bf --- /dev/null +++ b/docs/doc/sensor/README.md @@ -0,0 +1,18 @@ +# 传感器 + +- [力敏传感器](/doc/sensor/force_sensor) + +- [气敏传感器](/doc/sensor/gas_sensor) + +- [热敏传感器](/doc/sensor/heat_sensor) + +- [湿敏传感器](/doc/sensor/humidity_sensor) + +- [磁敏传感器](/doc/sensor/magneto_sensor) + +- [光电传感器](/doc/sensor/photoelec_sensor) + +- [压强传感器](/doc/sensor/pressure_sensor) + +- [声音传感器](/doc/sensor/voice_sensor) +