[doc] move development_guide rst html files out,update doc url in readme
jzlv
14
README.md
@ -134,9 +134,9 @@ For more information, please visit the BouffaloLab developer website: [https://d
|
||||
|
||||
## Documentation Tutorial
|
||||
|
||||
Contains a quick start tutorial for bl mcu sdk development, api manual and a detailed introduction to the driver framework, etc.
|
||||
To get more bl mcu sdk documentation tutorial, like api manual or peripheral demo and so on, please visit:
|
||||
|
||||
- [bl mcu sdk documentation tutorial](https://htmlpreview.github.io/?https://github.com/bouffalolab/bl_mcu_sdk/blob/master/docs/development_guide_en/build/html/index.html)
|
||||
- [bl mcu sdk documentation tutorial](https://dev.bouffalolab.com/media/doc/sdk/bl_mcu_sdk_en/index.html)
|
||||
|
||||
## Video Tutorial
|
||||
|
||||
@ -146,7 +146,7 @@ Contains a quick start tutorial for bl mcu sdk development, api manual and a det
|
||||
|
||||
### Command Line Development
|
||||
|
||||
For the tools needed for command line development, please refer to [linux development guide](http://bouffalolab.gitee.io/bl_mcu_sdk/get_started/Linux_quick_start_ubuntu.html)
|
||||
For the tools needed for command line development, please refer to [linux development guide](https://dev.bouffalolab.com/media/doc/sdk/bl_mcu_sdk_en/get_started/Linux_quick_start_ubuntu.html)
|
||||
|
||||
- [cmake 3.19](https://cmake.org/files/v3.19/), cmake compilation tool, it is recommended to use cmake v3.15 or above
|
||||
- [riscv64-unknown-elf-gcc](https://gitee.com/bouffalolab/toolchain_gcc_sifive_linux), risc-v linux toolchain，download command:
|
||||
@ -159,7 +159,7 @@ git clone https://gitee.com/bouffalolab/toolchain_gcc_sifive_linux.git
|
||||
|
||||
### Eclipse Development
|
||||
|
||||
For the tools needed for Eclipse development, please refer to [Eclipse Development Guide](http://bouffalolab.gitee.io/bl_mcu_sdk/get_started/Windows_quick_start_eclipse.html)
|
||||
For the tools needed for Eclipse development, please refer to [Eclipse Development Guide](https://dev.bouffalolab.com/media/doc/sdk/bl_mcu_sdk_en/get_started/Windows_quick_start_eclipse.html)
|
||||
|
||||
- [Eclipse](https://dev.bouffalolab.com/media/upload/download/BouffaloLab_eclipse_x86_64_win.zip) eclipse development free installation package under Windows
|
||||
- [riscv64-unknown-elf-gcc](https://gitee.com/bouffalolab/toolchain_gcc_sifive_windows), risc-v windows toolchain，download command:
|
||||
@ -174,7 +174,7 @@ git clone https://gitee.com/bouffalolab/toolchain_gcc_sifive_windows.git
|
||||
|
||||
### CDK Development
|
||||
|
||||
For tools needed for CDK development, please refer to [CDK Development Guide](http://bouffalolab.gitee.io/bl_mcu_sdk/get_started/Windows_quick_start_cdk.html)
|
||||
For tools needed for CDK development, please refer to [CDK Development Guide](https://dev.bouffalolab.com/media/doc/sdk/bl_mcu_sdk_en/get_started/Windows_quick_start_cdk.html)
|
||||
|
||||
- [CDK](https://occ.t-head.cn/development/activities/cdk), Jianchi CDK integrated development environment of T-Head , it is recommended to use CDK v2.8.4 or above
|
||||
|
||||
@ -186,6 +186,10 @@ Graphical programming tools provided by Bouffalolab:
|
||||
- [Bouffalo Lab Dev Cube For Windows](https://dev.bouffalolab.com/media/upload/download/BouffaloLabDevCube-1.5.3-win32.zip)
|
||||
- [Bouffalo Lab Dev Cube For Ubuntu](https://dev.bouffalolab.com/media/upload/download/BouffaloLabDevCube-1.5.3-linux-x86.tar.gz)
|
||||
|
||||
### Board Config Wizard
|
||||
|
||||
We provide [BL Config Wizard](https://dev.bouffalolab.com/media/config/index.html) to generate `clock_config.h`、 `pinmux_config.h` and `peripheral_config.h` file online.
|
||||
|
||||
## How to make sdk as submodule
|
||||
|
||||
First add bl_mcu_sdk to your own project using the add submodule command, and then commit the gitmodules file to the remote repo.
|
||||
|
||||
14
README_zh.md
@ -134,9 +134,9 @@ bl_mcu_sdk
|
||||
|
||||
## 文档教程
|
||||
|
||||
包含 bl mcu sdk 开发的快速入门教程， api 手册以及驱动框架等详细介绍
|
||||
获取更多 bl mcu sdk 开发相关的教程，如 api 手册、外设 demo 等，请参考：
|
||||
|
||||
- [bl mcu sdk 文档教程](http://bouffalolab.gitee.io/bl_mcu_sdk)
|
||||
- [bl mcu sdk 文档教程](https://dev.bouffalolab.com/media/doc/sdk/bl_mcu_sdk_zh/index.html)
|
||||
|
||||
## 视频教程
|
||||
|
||||
@ -146,7 +146,7 @@ bl_mcu_sdk
|
||||
|
||||
### 命令行开发
|
||||
|
||||
命令行开发需要的工具，具体使用方法参考 [linux 开发指南](http://bouffalolab.gitee.io/bl_mcu_sdk/get_started/Linux_quick_start_ubuntu.html)
|
||||
命令行开发需要的工具，具体使用方法参考 [linux 开发指南](https://dev.bouffalolab.com/media/doc/sdk/bl_mcu_sdk_zh/get_started/Linux_quick_start_ubuntu.html)
|
||||
|
||||
- [cmake 3.19](https://cmake.org/files/v3.19/)， cmake 编译工具，建议使用 cmake v3.15 以上版本
|
||||
- [riscv64-unknown-elf-gcc](https://gitee.com/bouffalolab/toolchain_gcc_sifive_linux), risc-v linux 端工具链，下载方式：
|
||||
@ -159,7 +159,7 @@ git clone https://gitee.com/bouffalolab/toolchain_gcc_sifive_linux.git
|
||||
|
||||
### Eclipse开发
|
||||
|
||||
Eclipse 开发需要的工具，具体使用方法参考 [Eclipse 开发指南](http://bouffalolab.gitee.io/bl_mcu_sdk/get_started/Windows_quick_start_eclipse.html)
|
||||
Eclipse 开发需要的工具，具体使用方法参考 [Eclipse 开发指南](https://dev.bouffalolab.com/media/doc/sdk/bl_mcu_sdk_zh/get_started/Windows_quick_start_eclipse.html)
|
||||
|
||||
- [Eclipse](https://dev.bouffalolab.com/media/upload/download/BouffaloLab_eclipse_x86_64_win.zip) Windows 下 eclipse 开发免安装包
|
||||
- [riscv64-unknown-elf-gcc](https://gitee.com/bouffalolab/toolchain_gcc_sifive_windows), risc-v windows 端工具链，下载方式：
|
||||
@ -174,7 +174,7 @@ git clone https://gitee.com/bouffalolab/toolchain_gcc_sifive_windows.git
|
||||
|
||||
### CDK开发
|
||||
|
||||
CDK 开发需要的工具，具体使用方法参考 [CDK 开发指南](http://bouffalolab.gitee.io/bl_mcu_sdk/get_started/Windows_quick_start_cdk.html)
|
||||
CDK 开发需要的工具，具体使用方法参考 [CDK 开发指南](https://dev.bouffalolab.com/media/doc/sdk/bl_mcu_sdk_zh/get_started/Windows_quick_start_cdk.html)
|
||||
|
||||
- [CDK](https://occ.t-head.cn/development/activities/cdk)，平头哥剑池 CDK 集成开发环境，建议使用 CDK v2.8.4 以上版本
|
||||
|
||||
@ -186,6 +186,10 @@ CDK 开发需要的工具，具体使用方法参考 [CDK 开发指南](http://b
|
||||
- [Bouffalo Lab Dev Cube For Windows](https://dev.bouffalolab.com/media/upload/download/BouffaloLabDevCube-1.5.3-win32.zip)
|
||||
- [Bouffalo Lab Dev Cube For Ubuntu](https://dev.bouffalolab.com/media/upload/download/BouffaloLabDevCube-1.5.3-linux-x86.tar.gz)
|
||||
|
||||
### Board Config Wizard
|
||||
|
||||
我们提供了[BL Config Wizard](https://dev.bouffalolab.com/media/config/index.html)，可以在线生成 `clock_config.h`、 `pinmux_config.h` 和 `peripheral_config.h` 文件。
|
||||
|
||||
## 如何将 SDK 作为 submodule 使用
|
||||
|
||||
首先使用添加子模块的命令添加到你自己的工程下，然后将 gitmodules 文件提交到远程仓库。
|
||||
|
||||
@ -1,4 +0,0 @@
|
||||
# Sphinx build info version 1
|
||||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
||||
config: c1a44f4f683944084f04b029ea7630d0
|
||||
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
||||
|
Before Width: | Height: | Size: 24 KiB |
|
Before Width: | Height: | Size: 38 KiB |
|
Before Width: | Height: | Size: 8.3 KiB |
|
Before Width: | Height: | Size: 46 KiB |
|
Before Width: | Height: | Size: 109 KiB |
|
Before Width: | Height: | Size: 5.7 MiB |
|
Before Width: | Height: | Size: 302 KiB |
|
Before Width: | Height: | Size: 259 KiB |
|
Before Width: | Height: | Size: 2.7 MiB |
|
Before Width: | Height: | Size: 45 KiB |
|
Before Width: | Height: | Size: 188 KiB |
|
Before Width: | Height: | Size: 47 KiB |
|
Before Width: | Height: | Size: 49 KiB |
|
Before Width: | Height: | Size: 49 KiB |
|
Before Width: | Height: | Size: 17 KiB |
|
Before Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 84 KiB |
|
Before Width: | Height: | Size: 108 KiB |
|
Before Width: | Height: | Size: 114 KiB |