diff --git a/docs/develop/README.md b/docs/develop/README.md index f49ed869ef..61aa9b4ad3 100644 --- a/docs/develop/README.md +++ b/docs/develop/README.md @@ -5,6 +5,8 @@ 本节介绍 如何搭建开发环境、底层框架是什么样的、如何支持新的机型和设备、如何修改飞行控制算法、如何添加新模式、如何集成新硬件以及飞控与外部通信是怎么实现的等。 +## 如何开始 + - 如何快速入门，比如：[搭建开发环境](./01.快速入门/01.setup-develop-environment.md)、[编译项目代码](01.快速入门/02.build-code.md)、[断点单步调试](./01.快速入门/03.ide-debug.md)等 - 系统框架介绍，比如：[系统启动流程](./03.系统框架/03.system-startup.md)、[FINSH终端](./03.系统框架/05.finsh-console.md)、[ULOG日志](./03.系统框架/07.micro-log.md)等 @@ -21,7 +23,9 @@ - 如何调试分析 -## 社区支持 +## 获取帮助 + +核心开发团队和社区成员活跃于以下渠道，您可以从以下方式获得帮助。 问题反馈： @@ -29,6 +33,18 @@ 论坛讨论： +## 反馈问题 + +如果您在使用 NextPilot 时遇到任何问题，请先在 [Github Discussions](https://github.com/nextpilot/nextpilot-flight-control/discussions) 上发布帖子（因为它们可能是由飞控配置引起的）。 + +根据开发团队指导，如果确定是代码问题则需要在 [Github Issue](https://github.com/nextpilot/nextpilot-flight-control/issues) 上反馈问题。如果可能，请提供[飞行日志](https://logs.px4.io)和其他信息。 + +## 开源许可 + +在 [BSD 3-clause](https://opensource.org/licenses/BSD-3-Clause) 许可证的条款，您可以免费使用和修改 [nextpilot-flight-control](https://github.com/nextpilot/nextpilot-flight-control) 代码，没有任何商业风险。 + +本文档采用 [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) 协议。 + ## 致谢 -开发文档中，借用了 [PX4 用户指南](https://gitee.com/rtthread/docs-online) 和 [RT-Thread 在线文档](https://gitee.com/rtthread/docs-online) 等部分资料，在此表示感谢。 +开发文档中，借用了 [PX4 用户指南](https://docs.px4.io) 和 [RT-Thread 在线文档](https://gitee.com/rtthread/docs-online) 等部分资料，在此表示感谢。 diff --git "a/docs/manual/01.\345\277\253\351\200\237\345\205\245\351\227\250/flight_controller_selection.md" "b/docs/manual/01.\345\277\253\351\200\237\345\205\245\351\227\250/flight_controller_selection.md" index be88195d62..73307f3a9d 100644 --- "a/docs/manual/01.\345\277\253\351\200\237\345\205\245\351\227\250/flight_controller_selection.md" +++ "b/docs/manual/01.\345\277\253\351\200\237\345\205\245\351\227\250/flight_controller_selection.md" @@ -1,4 +1,4 @@ -# 支持的硬件 +# 硬件支持 Flight controllers are the "brains" of an unmanned vehicle. Nextpilot can run on [many flight controller boards](../flight_controller/README.md). diff --git "a/docs/manual/01.\345\277\253\351\200\237\345\205\245\351\227\250/frame_selection.md" "b/docs/manual/01.\345\277\253\351\200\237\345\205\245\351\227\250/frame_selection.md" index a139bf7d7f..6d268bf25b 100644 --- "a/docs/manual/01.\345\277\253\351\200\237\345\205\245\351\227\250/frame_selection.md" +++ "b/docs/manual/01.\345\277\253\351\200\237\345\205\245\351\227\250/frame_selection.md" @@ -1,4 +1,4 @@ -# 支持的机架 +# 机架支持 PX4 supports air, surface, and submersible vehicles. You can see a full list of the vehicle types and variants ("frames") that have been tested/tuned for use with PX4 here: [Airframe Reference](../airframes/airframe_reference.md). diff --git "a/docs/manual/07.\346\240\207\345\207\206\351\205\215\347\275\256/05.flight_controller_orientation.md" "b/docs/manual/07.\346\240\207\345\207\206\351\205\215\347\275\256/05.flight_controller_orientation.md" index a892bbe353..4f0ac3cafb 100644 --- "a/docs/manual/07.\346\240\207\345\207\206\351\205\215\347\275\256/05.flight_controller_orientation.md" +++ "b/docs/manual/07.\346\240\207\345\207\206\351\205\215\347\275\256/05.flight_controller_orientation.md" @@ -1,4 +1,4 @@ -# Flight Controller/Sensor Orientation +# 安装方向 By default the flight controller and external compass(es) (if present) should be placed on the frame top-side up, oriented so that the arrow points towards the front of the vehicle. If the board or any external compasses are mounted in any other orientation then you will need configure this in the firmware. diff --git "a/docs/manual/07.\346\240\207\345\207\206\351\205\215\347\275\256/compass.md" "b/docs/manual/07.\346\240\207\345\207\206\351\205\215\347\275\256/06.compass.md" similarity index 100% rename from "docs/manual/07.\346\240\207\345\207\206\351\205\215\347\275\256/compass.md" rename to "docs/manual/07.\346\240\207\345\207\206\351\205\215\347\275\256/06.compass.md" diff --git "a/docs/manual/07.\346\240\207\345\207\206\351\205\215\347\275\256/accelerometer.md" "b/docs/manual/07.\346\240\207\345\207\206\351\205\215\347\275\256/07.accelerometer.md" similarity index 100% rename from "docs/manual/07.\346\240\207\345\207\206\351\205\215\347\275\256/accelerometer.md" rename to "docs/manual/07.\346\240\207\345\207\206\351\205\215\347\275\256/07.accelerometer.md" diff --git "a/docs/manual/07.\346\240\207\345\207\206\351\205\215\347\275\256/gyroscope.md" "b/docs/manual/07.\346\240\207\345\207\206\351\205\215\347\275\256/09.gyroscope.md" similarity index 100% rename from "docs/manual/07.\346\240\207\345\207\206\351\205\215\347\275\256/gyroscope.md" rename to "docs/manual/07.\346\240\207\345\207\206\351\205\215\347\275\256/09.gyroscope.md" diff --git "a/docs/manual/07.\346\240\207\345\207\206\351\205\215\347\275\256/level_horizon_calibration.md" "b/docs/manual/07.\346\240\207\345\207\206\351\205\215\347\275\256/11.level_horizon_calibration.md" similarity index 100% rename from "docs/manual/07.\346\240\207\345\207\206\351\205\215\347\275\256/level_horizon_calibration.md" rename to "docs/manual/07.\346\240\207\345\207\206\351\205\215\347\275\256/11.level_horizon_calibration.md" diff --git "a/docs/manual/07.\346\240\207\345\207\206\351\205\215\347\275\256/airspeed.md" "b/docs/manual/07.\346\240\207\345\207\206\351\205\215\347\275\256/12.airspeed.md" similarity index 100% rename from "docs/manual/07.\346\240\207\345\207\206\351\205\215\347\275\256/airspeed.md" rename to "docs/manual/07.\346\240\207\345\207\206\351\205\215\347\275\256/12.airspeed.md" diff --git a/docs/manual/README.md b/docs/manual/README.md index d6495fc514..adfa5848ab 100644 --- a/docs/manual/README.md +++ b/docs/manual/README.md @@ -1,3 +1,38 @@ # 用户手册 -Nextpilot是一款基于RT-Thread和PX4的国产专业飞控系统。 +NextPilot飞控系统是一款功能丰富、高度扩展、稳定可靠的国产先进自动驾驶仪。能够便捷的应用于教育、研究和工业等领域，让工程师专注于自己的擅长领域（比如嵌入式、控制算法、应用业务）进行高效的开发。 + +!!! note + 本手册包含了组装、配置和安全飞行基于 NextPilot 的无人机所需的一切，如果您对贡献项目感兴趣，请查看 [开发指南](../develop/) 部分。 + +## 如何开始 + +### 想使用 NextPilot 进行飞行 + +### 想适配 NextPilot 到新硬件 + +## 获取帮助 + +核心开发团队和社区成员活跃于以下渠道，您可以从以下方式获得帮助。 + +交流论坛： + +问题反馈： + +提交代码： + +## 反馈问题 + +如果您在使用 NextPilot 时遇到任何问题，请先在 [Github Discussions](https://github.com/nextpilot/nextpilot-flight-control/discussions) 上发布帖子（因为它们可能是由飞控配置引起的）。 + +根据开发团队指导，如果确定是代码问题则需要在 [Github Issue](https://github.com/nextpilot/nextpilot-flight-control/issues) 上反馈问题。如果可能，请提供[飞行日志](https://logs.px4.io)和其他信息。 + +## 开源许可 + +在 [BSD 3-clause](https://opensource.org/licenses/BSD-3-Clause) 许可证的条款，您可以免费使用和修改 [nextpilot-flight-control](https://github.com/nextpilot/nextpilot-flight-control) 代码，没有任何商业风险。 + +本文档采用 [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) 协议。 + +## 致谢 + +用户手册中，大量借用了 [PX4 用户指南](https://docs.px4.io)中的内容，在此表示感谢。