Skip to content

Commit

Permalink
修复docs中的错误描述
Browse files Browse the repository at this point in the history
  • Loading branch information
ComerLater committed Jun 13, 2024
1 parent e9c4d1a commit 537c71a
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 22 deletions.
15 changes: 7 additions & 8 deletions docs/develop/01.快速入门/01.setup-develop-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,27 +17,26 @@ NextPilot 基于 [RT-Thread](https://www.rt-thread.org/) 实时操作系统而
> 注意:暂时工具链只能保存到`C:\nextpilot-windows-toolchain`文件夹,否则会提示找不到python.exe。
```bat
rem 克隆nextpilot开发工具链
rem gitee镜像地址 https://gitee.com/nextpilot/nextpilot-windows-toolchain.git
git clone --depth=1 https://github.com/nextpilot/nextpilot-windows-toolchain.git
```

2、双击`Nextpilot-windows-toolchain/start.bat`脚本启动CMD终端,并已经配置好了nextpilot开发环境。

3、在CMD终端里,切换到nextpilot-flight-control/bsps目录,然后运行命令进行编译/仿真:
3、在CMD终端里,切换到nextpilot-flight-control/bsps目录,然后运行命令进行配置/编译/仿真:

```bat
rem 克隆nextpilot飞控项目
rem gitee镜像地址 https://gitee.com/nextpilot/nextpilot-flight-control.git
git clone https://github.com/nextpilot/nextpilot-flight-control.git
rem 切换到bsps目录,比如bsps/sitl/qemu,使用qmeu跑软件在环
cd nextpilot-flight-control/bsps/sitl/qemu
rem 配置nextpilot项目,仅限开发者
scons --menuconfig
rem 雇佣10个线程编译default目标,更多目标参见config/xxxx.config文件
scons default -j10
rem 启用qemu进行虚拟飞行仿真
qemu.bat
```
Expand All @@ -51,7 +50,6 @@ qemu.bat

```shell
git clone --depth=1 https://github.com/nextpilot/nextpilot-ubunut-toolchain.git ~/.ndt

```

2、激活nextpilot工具链,首次运行会创建python venv环境并安装必要的工具。
Expand All @@ -64,16 +62,17 @@ source ~/.ndt/init.sh

```shell
# 克隆nextpilot飞控项目
# gitee镜像地址 https://gitee.com/nextpilot/nextpilot-flight-control.git
git clone https://github.com/nextpilot/nextpilot-flight-control.git ~/nextpilot-flight-control


# 切换到bsps目录,比如bsps/sitl/qemu,使用qmeu跑软件在环
cd ~/nextpilot-flight-control/bsps/sitl/qemu

# 配置nextpilot项目,仅限开发者
scons --menuconfig

# 雇佣10个线程编译default目标,更多目标参见config/xxxx.config文件
scons default -j10

# 启用qemu进行虚拟飞行仿真
./qemu.sh
```
Expand Down
7 changes: 5 additions & 2 deletions docs/develop/01.快速入门/02.build-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ git clone https://github.com/nextpilot/nextpilot-flight-control.git

> 注意:该功能仅限开发者
C/C++语言项目的裁剪配置本质上通过条件编译和宏的展开来实现的,nextpilot 借助 Kconfig 这套机制更方便的实现了这一功能
C/C++语言项目的裁剪配置本质上通过条件编译和宏的展开来实现的,nextpilot 借助 Kconfig 工具更方便的实现了这一功能

```shell
# 命令行界面
scons --menuconfig

# 图形用户界面
scons --guiconfig

```

## 生成工程
Expand All @@ -31,6 +31,7 @@ nextpilot 支持使用`scons --target=xxxx`生成 Keil、Vscode、CMake工程。
```shell
# 根据defaut目标生成MDK5工程,其中defaut不是必须得
scons default --target=mdk5

# 生成vscode工程
scons default --target=vsc
```
Expand Down Expand Up @@ -68,8 +69,10 @@ nextpilot 飞控内部集成一套六自由度模型(SDOFS)用来生成控
```shell
# 切换sitl/qemu目录
cd nextpilot-flight-control/bsps/sitl/qemu

# 编译工程
scons default -j8

# 在qemu模拟器中运行nextpilot
qemu.bat
```
Expand Down
22 changes: 10 additions & 12 deletions docs/develop/01.快速入门/03.ide-debug.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# 断点单步调试

NextPilot支持 Keil MDK5 和 VS Code 两种集成开发环境,两者都是先通过scons工具生成相应的 MDK5 工程和 VS Code 配置,然后再使用 IDE 进行编译、调试、烧录等。
NextPilot支持 Keil MDK5、IAR 和 VS Code 等集成开发环境,两者都是先通过scons工具生成相应的 MDK5 工程和 VS Code 配置,然后再使用 IDE 进行编译、调试、烧录等。

> 注意:飞行仿真sitl/qemu只支持VS Code+Gcc,**不支持 MDK5**普通STM32程序支持 Vscode 和 MDK5,但是推荐 MDK5。
> 注意:飞行仿真 sitl/qemu 只支持VS Code + Gcc,**不支持 MDK5**普通 STM32 程序支持 Vscode 和 MDK5,但是推荐 MDK5。
Vscode一款很好的编辑器,拥有极强的扩展性,因此推荐使用VScode进行代码编辑,至于编译和调试可以根据个人喜好。
Vscode一款很好的编辑器,拥有极强的扩展性,因此推荐使用 VScode 进行代码编辑,至于编译和调试可以根据个人喜好。

## Keil MDK5

Expand All @@ -18,14 +18,12 @@ Vscode一款很好的编辑器,拥有极强的扩展性,因此推荐使用VS

跳转到对应版本页面之后,需要填写很多信息,尤其是`LIC or PSN`,因此不适合绝大部分个人开发者。其实 MDK 都是使用 **有规律的下载链接**,相信聪明的你一定能够找其中的规律哦,通过该方法可以下载任意历史版本。

|版本|下载链接|
|---|---|
|MDK525.EXE|<https://armkeil.blob.core.windows.net/eval/MDK525.EXE>|
|MDK527.EXE|<https://armkeil.blob.core.windows.net/eval/MDK527.EXE>|
|MDK529.EXE|<https://armkeil.blob.core.windows.net/eval/MDK529.EXE>|
|MDK536.EXE|<https://armkeil.blob.core.windows.net/eval/MDK536.EXE>|
|MDK538a.EXE|<https://armkeil.blob.core.windows.net/eval/MDK538a.EXE>|
|MDK540.EXE|<https://armkeil.blob.core.windows.net/eval/MDK540.EXE>|
- <https://armkeil.blob.core.windows.net/eval/MDK525.EXE>
- <https://armkeil.blob.core.windows.net/eval/MDK527.EXE>
- <https://armkeil.blob.core.windows.net/eval/MDK529.EXE>
- <https://armkeil.blob.core.windows.net/eval/MDK536.EXE>
- <https://armkeil.blob.core.windows.net/eval/MDK538a.EXE>
- <https://armkeil.blob.core.windows.net/eval/MDK540.EXE>

除了安装keil工具,芯片的pack包也是必不可少的,请到<https://www.keil.arm.com/devices>找到自己的芯片,并下载相应的pack。下面列出了STM32F1/F4/F7/H7当前最新版本的pack下载连接:

Expand Down Expand Up @@ -56,7 +54,7 @@ VS Code(全称 [Visual Studio Code](https://azure.microsoft.com/zh-cn/products

### 安装和配置

下载[Visual Stuio Code](https://azure.microsoft.com/zh-cn/products/visual-studio-code/),一路默认安装即可。然后使用vscode打开`nextpilot-flight-control.code-workspace`,如果是第一次打开会提醒您安装`推荐扩展`,一定要点`确定`哈,会自动安装以下扩展:
下载[Visual Studio Code](https://azure.microsoft.com/zh-cn/products/visual-studio-code/),一路默认安装即可。然后使用vscode打开`nextpilot-flight-control.code-workspace`,如果是第一次打开会提醒您安装`推荐扩展`,一定要点`确定`哈,会自动安装以下扩展:

|插件|用途|
| :--- | :--- |
Expand Down

0 comments on commit 537c71a

Please sign in to comment.