diff --git a/docs/ko/qgc-dev-guide/command_line_options.md b/docs/ko/qgc-dev-guide/command_line_options.md index a66cd53..215e47b 100644 --- a/docs/ko/qgc-dev-guide/command_line_options.md +++ b/docs/ko/qgc-dev-guide/command_line_options.md @@ -8,21 +8,21 @@ You will need to open a command prompt or terminal, change directory to where ** Windows Command Prompt: -```bash +```sh cd "\Program Files (x86)\qgroundcontrol" qgroundcontrol --logging:full ``` OSX Terminal app (**Applications/Utilities**): -```bash +```sh cd /Applications/qgroundcontrol.app/Contents/MacOS/ ./qgroundcontrol --logging:full ``` Linux Terminal: -```bash +```sh ./qgroundcontrol-start.sh --logging:full ``` @@ -30,16 +30,16 @@ Linux Terminal: The options/command line arguments are listed in the table below. -| Option | Description | -| --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| `--clear-settings` | Clears the app settings (reverts _QGroundControl_ back to default settings). | -| `--logging:full` | Turns on full logging. See [Console Logging](https://docs.qgroundcontrol.com/en/settings_view/console_logging.html#logging-from-the-command-line). | -| `--logging:full,LinkManagerVerboseLog,ParameterLoaderLog` | Turns on full logging and turns off the following listed comma-separated logging options. | -| `--logging:LinkManagerLog,ParameterLoaderLog` | Turns on the specified comma separated logging options | -| `--unittest:name` | (Debug builds only) Runs the specified unit test. Leave off `:name` to run all tests. | -| `--unittest-stress:name` | (Debug builds only) Runs the specified unit test 20 times in a row. Leave off :name to run all tests. | -| `--fake-mobile` | Simulates running on a mobile device. | -| `--test-high-dpi` | Simulates running _QGroundControl_ on a high DPI device. | +| Option | Description | +| --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | +| `--clear-settings` | Clears the app settings (reverts _QGroundControl_ back to default settings). | +| `--logging:full` | Turns on full logging. See [Console Logging](../../qgc-user-guide/settings_view/console_logging.html#logging-from-the-command-line). | +| `--logging:full,LinkManagerVerboseLog,ParameterLoaderLog` | Turns on full logging and turns off the following listed comma-separated logging options. | +| `--logging:LinkManagerLog,ParameterLoaderLog` | Turns on the specified comma separated logging options | +| `--unittest:name` | (Debug builds only) Runs the specified unit test. Leave off `:name` to run all tests. | +| `--unittest-stress:name` | (Debug builds only) Runs the specified unit test 20 times in a row. Leave off :name to run all tests. | +| `--fake-mobile` | Simulates running on a mobile device. | +| `--test-high-dpi` | Simulates running _QGroundControl_ on a high DPI device. | Notes: diff --git a/docs/ko/qgc-dev-guide/getting_started/index.md b/docs/ko/qgc-dev-guide/getting_started/index.md index c01c1af..8019bbe 100644 --- a/docs/ko/qgc-dev-guide/getting_started/index.md +++ b/docs/ko/qgc-dev-guide/getting_started/index.md @@ -2,14 +2,15 @@ qt_version: 5.15.2 --- -# Getting Started +# Getting Started with Source and Builds This topic explains how to get the _QGroundControl_ source code and build it either natively or within a _Vagrant_ environment. It also provides information about optional or OS specific functionality. ## Daily Builds -If you just want to test (and not debug) a recent build of _QGroundControl_ you can use the [Daily Build](https://docs.qgroundcontrol.com/en/releases/daily_builds.html). Versions are provided for all platforms. +If you just want to test (and not debug) a recent build of _QGroundControl_ you can use the [Daily Build](../../qgc-user-guide/releases/daily_builds.md). +Versions are provided for all platforms. ## Source Code @@ -19,11 +20,14 @@ It is [dual-licensed under Apache 2.0 and GPLv3](https://github.com/mavlink/qgro To get the source files: 1. Clone the repo (or your fork) including submodules: - ``` + + ```sh git clone --recursive -j8 https://github.com/mavlink/qgroundcontrol.git ``` + 2. Update submodules (required each time you pull new source code): - ``` + + ```sh git submodule update --recursive ``` @@ -134,9 +138,11 @@ To install Qt: ::: - **Ubuntu:** + - Airmap: Create a file named **user\_config.pri** (in the repo root directory) containing the text `DEFINES += DISABLE_AIRMAP`. This can be done in a bash terminal using the command: - ``` + + ```sh echo -e "DEFINES += DISABLE_AIRMAP\r\n" | tee user_config.pri ``` @@ -169,25 +175,28 @@ To install Qt: Example commands to build a default QGC and run it afterwards: 1. Make sure you cloned the repository and updated the submodules before, see chapter _Source Code_ above and switch into the repository folder: - ``` + + ```sh cd qgroundcontrol ``` 2. Create and enter a shadow build directory: - ``` + + ```sh mkdir build cd build ``` 3. Configure the build using the qmake script in the root of the repository: - ``` + + ```sh qmake ../ ``` 4. Run make to compile and link. To accelerate the process things you can use the `-j{number of threads}` parameter. - ``` + ```sh make -j12 ``` @@ -195,14 +204,15 @@ Example commands to build a default QGC and run it afterwards: You can also specify build time flags here. For example, you could disable airmap inclusion using the command: - ``` + ```sh DEFINES+=DISABLE_AIRMAP make build ``` ::: 5. Run the QGroundcontrol binary that was just built: - ``` + + ```sh ./staging/QGroundControl ``` diff --git a/docs/ko/qgc-dev-guide/tools/index.md b/docs/ko/qgc-dev-guide/tools/index.md index d2f1bd8..4da9e41 100644 --- a/docs/ko/qgc-dev-guide/tools/index.md +++ b/docs/ko/qgc-dev-guide/tools/index.md @@ -11,10 +11,6 @@ and accessing the System Shell over MAVLink. Tools include: - **[Mock Link](../tools/mock_link.md)** (Daily Builds only) - Creates and stops multiple simulated vehicle links. -- **[Replay Flight Data](https://docs.qgroundcontrol.com/en/app_menu/replay_flight_data.html)** - Replay a telemetry log (User Guide). -- **[MAVLink Inspector](https://docs.qgroundcontrol.com/en/app_menu/mavlink_inspector.html)** - Display received MAVLink messages/values. -- **[MAVLink Analyzer](https://docs.qgroundcontrol.com/en/app_menu/mavlink_analyzer.html)** - Plot trends for MAVLink messages/values. -- **[Custom Command Widget](https://docs.qgroundcontrol.com/en/app_menu/custom_command_widget.html)** - Load custom/test QML UI at runtime. -- **[Onboard Files](https://docs.qgroundcontrol.com/en/app_menu/onboard_files.html)** - Navigate vehicle file system and upload/download files. -- **[HIL Config Widget](https://docs.qgroundcontrol.com/en/app_menu/hil_config.html)** - Settings for HIL simulators. -- **[MAVLink Console](https://docs.qgroundcontrol.com/en/analyze_view/mavlink_console.html)** (PX4 Only) - Connect to the PX4 nsh shell and send commands. +- **[Replay Flight Data](../../qgc-user-guide/fly_view/replay_flight_data.md)** - Replay a telemetry log (User Guide). +- **[MAVLink Inspector](../../qgc-user-guide/analyze_view/mavlink_inspector.html)** - Display received MAVLink messages/values and plot trends. +- **[MAVLink Console](../../qgc-user-guide/analyze_view/mavlink_console.html)** (PX4 Only) - Connect to the PX4 nsh shell and send commands. diff --git a/docs/ko/qgc-user-guide/index.md b/docs/ko/qgc-user-guide/index.md index ecfd751..cccc643 100644 --- a/docs/ko/qgc-user-guide/index.md +++ b/docs/ko/qgc-user-guide/index.md @@ -23,5 +23,5 @@ _QGroundControl_을 이용하여 PX4나 ArduPilot 구동 차량을 설정하고 ::: :::tip -_QGroundControl_에 관련된 개발, 아키텍처, 기여 및 번역에 관련한 정보는 [개발자 가이드](https://dev.qgroundcontrol.com/en/)를 참고하십시오. +Information about _QGroundControl_ development, architecture, contributing, and translating can be found in the [Developer Guide](../qgc-dev-guide/index.md) section. ::: diff --git a/docs/ko/qgc-user-guide/releases/stable_v3.2_long.md b/docs/ko/qgc-user-guide/releases/stable_v3.2_long.md index d22dd5c..0921cad 100644 --- a/docs/ko/qgc-user-guide/releases/stable_v3.2_long.md +++ b/docs/ko/qgc-user-guide/releases/stable_v3.2_long.md @@ -47,7 +47,7 @@ _비행 후 텔레메트리 로그 저장_을 켠 경우 더 이상 차량이 이전 버전의 _QGroundControl_은 미션, 지오펜스 및 집회 지점을 별도의 파일(**.mission**, **.fence**, **.rally**)에 저장하였습니다 . QGroundControl은 이제 비행 계획과 관련된 모든 정보를 파일 확장자를 **.plan**인 _계획 파일_을 사용합니다. -형식에 대한 정보는 [계획 파일 형식](https://dev.qgroundcontrol.com/en/file_formats/plan.html)(QGroundControl 개발자 안내서)을 참고하십시오. +Information about the format can be found in [Plan File Format](../../qgc-dev-guide/file_formats/plan.md) (QGC Developer Guide). ### 계획 툴바 diff --git a/docs/ko/qgc-user-guide/settings_view/console_logging.md b/docs/ko/qgc-user-guide/settings_view/console_logging.md index d256dc9..470df5d 100644 --- a/docs/ko/qgc-user-guide/settings_view/console_logging.md +++ b/docs/ko/qgc-user-guide/settings_view/console_logging.md @@ -27,24 +27,34 @@ The most commmonly used logging options are listed below. 이 작업을 수행하는 방법과 추적 출력은 운영체제에 따라 조금씩 다릅니다. - 윈도우 + - 명령 프롬프트를 열고 디렉토리를 **qgroundcontrol.exe** 위치로 변경후 실행합니다. - ```bash + + ```sh bash cd "\Program Files (x86)\qgroundcontrol" qgroundcontrol --logging:full ``` + - _QGroundControl_이 시작되면 로그 출력이 있는 별도의 콘솔 창을 사용합니다. + - OSX + - 터미널에서 _QGroundControl_을 실행합니다. 터미널 앱은 응용 프로그램/유틸리티에 있습니다. 터미널이 열리면 다음을 입력합니다. - ```bash + + ```sh bash cd /Applications/qgroundcontrol.app/Contents/MacOS/ ./qgroundcontrol --logging:full ``` + - 로그 추적은 터미널 창으로 출력됩니다. -- ## 리눅스 - ```bash + +- Linux + + ```sh bash ./qgroundcontrol-start.sh --logging:full ``` + - 로그 추적은 실행 중인 셸에 출력됩니다. diff --git a/docs/tr/qgc-dev-guide/command_line_options.md b/docs/tr/qgc-dev-guide/command_line_options.md index a66cd53..215e47b 100644 --- a/docs/tr/qgc-dev-guide/command_line_options.md +++ b/docs/tr/qgc-dev-guide/command_line_options.md @@ -8,21 +8,21 @@ You will need to open a command prompt or terminal, change directory to where ** Windows Command Prompt: -```bash +```sh cd "\Program Files (x86)\qgroundcontrol" qgroundcontrol --logging:full ``` OSX Terminal app (**Applications/Utilities**): -```bash +```sh cd /Applications/qgroundcontrol.app/Contents/MacOS/ ./qgroundcontrol --logging:full ``` Linux Terminal: -```bash +```sh ./qgroundcontrol-start.sh --logging:full ``` @@ -30,16 +30,16 @@ Linux Terminal: The options/command line arguments are listed in the table below. -| Option | Description | -| --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| `--clear-settings` | Clears the app settings (reverts _QGroundControl_ back to default settings). | -| `--logging:full` | Turns on full logging. See [Console Logging](https://docs.qgroundcontrol.com/en/settings_view/console_logging.html#logging-from-the-command-line). | -| `--logging:full,LinkManagerVerboseLog,ParameterLoaderLog` | Turns on full logging and turns off the following listed comma-separated logging options. | -| `--logging:LinkManagerLog,ParameterLoaderLog` | Turns on the specified comma separated logging options | -| `--unittest:name` | (Debug builds only) Runs the specified unit test. Leave off `:name` to run all tests. | -| `--unittest-stress:name` | (Debug builds only) Runs the specified unit test 20 times in a row. Leave off :name to run all tests. | -| `--fake-mobile` | Simulates running on a mobile device. | -| `--test-high-dpi` | Simulates running _QGroundControl_ on a high DPI device. | +| Option | Description | +| --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | +| `--clear-settings` | Clears the app settings (reverts _QGroundControl_ back to default settings). | +| `--logging:full` | Turns on full logging. See [Console Logging](../../qgc-user-guide/settings_view/console_logging.html#logging-from-the-command-line). | +| `--logging:full,LinkManagerVerboseLog,ParameterLoaderLog` | Turns on full logging and turns off the following listed comma-separated logging options. | +| `--logging:LinkManagerLog,ParameterLoaderLog` | Turns on the specified comma separated logging options | +| `--unittest:name` | (Debug builds only) Runs the specified unit test. Leave off `:name` to run all tests. | +| `--unittest-stress:name` | (Debug builds only) Runs the specified unit test 20 times in a row. Leave off :name to run all tests. | +| `--fake-mobile` | Simulates running on a mobile device. | +| `--test-high-dpi` | Simulates running _QGroundControl_ on a high DPI device. | Notes: diff --git a/docs/tr/qgc-dev-guide/getting_started/index.md b/docs/tr/qgc-dev-guide/getting_started/index.md index c01c1af..8019bbe 100644 --- a/docs/tr/qgc-dev-guide/getting_started/index.md +++ b/docs/tr/qgc-dev-guide/getting_started/index.md @@ -2,14 +2,15 @@ qt_version: 5.15.2 --- -# Getting Started +# Getting Started with Source and Builds This topic explains how to get the _QGroundControl_ source code and build it either natively or within a _Vagrant_ environment. It also provides information about optional or OS specific functionality. ## Daily Builds -If you just want to test (and not debug) a recent build of _QGroundControl_ you can use the [Daily Build](https://docs.qgroundcontrol.com/en/releases/daily_builds.html). Versions are provided for all platforms. +If you just want to test (and not debug) a recent build of _QGroundControl_ you can use the [Daily Build](../../qgc-user-guide/releases/daily_builds.md). +Versions are provided for all platforms. ## Source Code @@ -19,11 +20,14 @@ It is [dual-licensed under Apache 2.0 and GPLv3](https://github.com/mavlink/qgro To get the source files: 1. Clone the repo (or your fork) including submodules: - ``` + + ```sh git clone --recursive -j8 https://github.com/mavlink/qgroundcontrol.git ``` + 2. Update submodules (required each time you pull new source code): - ``` + + ```sh git submodule update --recursive ``` @@ -134,9 +138,11 @@ To install Qt: ::: - **Ubuntu:** + - Airmap: Create a file named **user\_config.pri** (in the repo root directory) containing the text `DEFINES += DISABLE_AIRMAP`. This can be done in a bash terminal using the command: - ``` + + ```sh echo -e "DEFINES += DISABLE_AIRMAP\r\n" | tee user_config.pri ``` @@ -169,25 +175,28 @@ To install Qt: Example commands to build a default QGC and run it afterwards: 1. Make sure you cloned the repository and updated the submodules before, see chapter _Source Code_ above and switch into the repository folder: - ``` + + ```sh cd qgroundcontrol ``` 2. Create and enter a shadow build directory: - ``` + + ```sh mkdir build cd build ``` 3. Configure the build using the qmake script in the root of the repository: - ``` + + ```sh qmake ../ ``` 4. Run make to compile and link. To accelerate the process things you can use the `-j{number of threads}` parameter. - ``` + ```sh make -j12 ``` @@ -195,14 +204,15 @@ Example commands to build a default QGC and run it afterwards: You can also specify build time flags here. For example, you could disable airmap inclusion using the command: - ``` + ```sh DEFINES+=DISABLE_AIRMAP make build ``` ::: 5. Run the QGroundcontrol binary that was just built: - ``` + + ```sh ./staging/QGroundControl ``` diff --git a/docs/tr/qgc-dev-guide/tools/index.md b/docs/tr/qgc-dev-guide/tools/index.md index d2f1bd8..4da9e41 100644 --- a/docs/tr/qgc-dev-guide/tools/index.md +++ b/docs/tr/qgc-dev-guide/tools/index.md @@ -11,10 +11,6 @@ and accessing the System Shell over MAVLink. Tools include: - **[Mock Link](../tools/mock_link.md)** (Daily Builds only) - Creates and stops multiple simulated vehicle links. -- **[Replay Flight Data](https://docs.qgroundcontrol.com/en/app_menu/replay_flight_data.html)** - Replay a telemetry log (User Guide). -- **[MAVLink Inspector](https://docs.qgroundcontrol.com/en/app_menu/mavlink_inspector.html)** - Display received MAVLink messages/values. -- **[MAVLink Analyzer](https://docs.qgroundcontrol.com/en/app_menu/mavlink_analyzer.html)** - Plot trends for MAVLink messages/values. -- **[Custom Command Widget](https://docs.qgroundcontrol.com/en/app_menu/custom_command_widget.html)** - Load custom/test QML UI at runtime. -- **[Onboard Files](https://docs.qgroundcontrol.com/en/app_menu/onboard_files.html)** - Navigate vehicle file system and upload/download files. -- **[HIL Config Widget](https://docs.qgroundcontrol.com/en/app_menu/hil_config.html)** - Settings for HIL simulators. -- **[MAVLink Console](https://docs.qgroundcontrol.com/en/analyze_view/mavlink_console.html)** (PX4 Only) - Connect to the PX4 nsh shell and send commands. +- **[Replay Flight Data](../../qgc-user-guide/fly_view/replay_flight_data.md)** - Replay a telemetry log (User Guide). +- **[MAVLink Inspector](../../qgc-user-guide/analyze_view/mavlink_inspector.html)** - Display received MAVLink messages/values and plot trends. +- **[MAVLink Console](../../qgc-user-guide/analyze_view/mavlink_console.html)** (PX4 Only) - Connect to the PX4 nsh shell and send commands. diff --git a/docs/tr/qgc-user-guide/index.md b/docs/tr/qgc-user-guide/index.md index 9a7b80b..7634f46 100644 --- a/docs/tr/qgc-user-guide/index.md +++ b/docs/tr/qgc-user-guide/index.md @@ -23,5 +23,5 @@ The information provided should be correct, but you may find missing information ::: :::tip -Information about _QGroundControl_ development, architecture, contributing, and translating can be found in the [Developers Guide](https://dev.qgroundcontrol.com/en/). +Information about _QGroundControl_ development, architecture, contributing, and translating can be found in the [Developer Guide](../qgc-dev-guide/index.md) section. ::: diff --git a/docs/tr/qgc-user-guide/releases/stable_v3.2_long.md b/docs/tr/qgc-user-guide/releases/stable_v3.2_long.md index 0056ad2..1d56f30 100644 --- a/docs/tr/qgc-user-guide/releases/stable_v3.2_long.md +++ b/docs/tr/qgc-user-guide/releases/stable_v3.2_long.md @@ -47,7 +47,7 @@ This is now supported from the Copy Trims button on the Radio setup page. Previous version of _QGroundControl_ saved missions, geo-fences and rally points in separate files (**.mission**, **.fence**, **.rally**). QGC now save all information related to a flight plan into a single file called a _Plan File_ with a file extension of **.plan**. -Information about the format can be found in [Plan File Format](https://dev.qgroundcontrol.com/en/file_formats/plan.html) (QGC Developer Guide). +Information about the format can be found in [Plan File Format](../../qgc-dev-guide/file_formats/plan.md) (QGC Developer Guide). ### Plan Toolbar diff --git a/docs/tr/qgc-user-guide/settings_view/console_logging.md b/docs/tr/qgc-user-guide/settings_view/console_logging.md index 3cfd225..e018df4 100644 --- a/docs/tr/qgc-user-guide/settings_view/console_logging.md +++ b/docs/tr/qgc-user-guide/settings_view/console_logging.md @@ -27,27 +27,37 @@ An alternate mechanism for logging is using the `--logging` command line option. How you do this and where the traces are output vary by OS: - Windows + - You must open a command prompt, change directory to the **qgroundcontrol.exe** location, and run it from there: bash cd "\Program Files (x86)\qgroundcontrol" qgroundcontrol --logging:full - ```bash + + ```sh cd "\Program Files (x86)\qgroundcontrol" qgroundcontrol --logging:full ``` + - When _QGroundControl_ starts you should see a separate console window open which will have the log output + - OSX + - You must run _QGroundControl_ from Terminal. The Terminal app is located in Applications/Utilities. Once Terminal is open paste the following into it: - ```bash + + ```sh Once Terminal is open paste the following into it: bash cd /Applications/qgroundcontrol.app/Contents/MacOS/ ./qgroundcontrol --logging:full ``` + - Log traces will output to the Terminal window. -- ## Linux - ```bash + +- Linux + + ```sh bash ./qgroundcontrol-start.sh --logging:full ``` + - Log traces will output to the shell you are running from. diff --git a/docs/zh/qgc-dev-guide/command_line_options.md b/docs/zh/qgc-dev-guide/command_line_options.md index 82872d0..b69fa5b 100644 --- a/docs/zh/qgc-dev-guide/command_line_options.md +++ b/docs/zh/qgc-dev-guide/command_line_options.md @@ -8,21 +8,21 @@ Windows命令提示符： -```bash +```sh cd "\Program Files (x86)\qgroundcontrol" qgroundcontrol --logging:full ``` OSX终端应用程序（应用程序/实用程序）： -```bash +```sh cd /Applications/qgroundcontrol.app/Contents/MacOS/ ./qgroundcontrol --logging:full ``` Linux终端： -```bash +```sh ./qgroundcontrol-start.sh --logging:full ``` @@ -30,16 +30,16 @@ Linux终端： 选项/命令行参数列在下表中。 -| 选项 | 描述 | -| --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| `--clear-settings` | Clears the app settings (reverts _QGroundControl_ back to default settings). | -| `--logging:full` | Turns on full logging. See [Console Logging](https://docs.qgroundcontrol.com/en/settings_view/console_logging.html#logging-from-the-command-line). | -| `--logging:full,LinkManagerVerboseLog,ParameterLoaderLog` | Turns on full logging and turns off the following listed comma-separated logging options. | -| `--logging:LinkManagerLog,ParameterLoaderLog` | Turns on the specified comma separated logging options | -| `--unittest:name` | (Debug builds only) Runs the specified unit test. Leave off `:name` to run all tests. | -| `--unittest-stress:name` | (Debug builds only) Runs the specified unit test 20 times in a row. Leave off :name to run all tests. | -| `--fake-mobile` | Simulates running on a mobile device. | -| `--test-high-dpi` | Simulates running _QGroundControl_ on a high DPI device. | +| 选项 | 描述 | +| --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | +| `--clear-settings` | Clears the app settings (reverts _QGroundControl_ back to default settings). | +| `--logging:full` | Turns on full logging. See [Console Logging](../../qgc-user-guide/settings_view/console_logging.html#logging-from-the-command-line). | +| `--logging:full,LinkManagerVerboseLog,ParameterLoaderLog` | Turns on full logging and turns off the following listed comma-separated logging options. | +| `--logging:LinkManagerLog,ParameterLoaderLog` | Turns on the specified comma separated logging options | +| `--unittest:name` | (Debug builds only) Runs the specified unit test. Leave off `:name` to run all tests. | +| `--unittest-stress:name` | (Debug builds only) Runs the specified unit test 20 times in a row. Leave off :name to run all tests. | +| `--fake-mobile` | Simulates running on a mobile device. | +| `--test-high-dpi` | Simulates running _QGroundControl_ on a high DPI device. | 笔记： diff --git a/docs/zh/qgc-dev-guide/getting_started/index.md b/docs/zh/qgc-dev-guide/getting_started/index.md index 18232da..71f5b6c 100644 --- a/docs/zh/qgc-dev-guide/getting_started/index.md +++ b/docs/zh/qgc-dev-guide/getting_started/index.md @@ -2,14 +2,15 @@ qt_version: 5.15.2 --- -# Getting Started +# Getting Started with Source and Builds 本主题说明如何获取QGroundControl源代码并在本机或在Vagrant(虚拟机)环境中构建它。 本主题还提供其他可选功能信息及特定于操作系统的功能信息。 It also provides information about optional or OS specific functionality. ## 每日构建 -如果您只是想测试 (而不是调试) 最近生成的 _QGroundControl_ ，那么请使用[Daily build](https://docs.qgroundcontrol.com/en/releases/daily_builds.html)。 官方提供了适用于所有平台的版本。 Versions are provided for all platforms. +If you just want to test (and not debug) a recent build of _QGroundControl_ you can use the [Daily Build](../../qgc-user-guide/releases/daily_builds.md). +Versions are provided for all platforms. ## 源代码 @@ -19,11 +20,14 @@ It is [dual-licensed under Apache 2.0 and GPLv3](https://github.com/mavlink/qgro 要获取源文件, 请执行以下操作: 1. Clone the repo (or your fork) including submodules: - ``` + + ```sh 克隆存储库 (或您的分叉), 包括子模块: `git clone --recursive -j8 https://github.com/mavlink/qgroundcontrol.git` ``` + 2. Update submodules (required each time you pull new source code): - ``` + + ```sh 2.更新子模块（每次拉新源代码时都这样做）： `git submodule update --recursive` ``` @@ -133,9 +137,11 @@ To install Qt: ::: - **Ubuntu:** + - Airmap: Create a file named **user\_config.pri** (in the repo root directory) containing the text `DEFINES += DISABLE_AIRMAP`. This can be done in a bash terminal using the command: - ``` + + ```sh This can be done in a bash terminal using the command: `echo -e "DEFINES += DISABLE_AIRMAP\r\n" | tee user_config.pri` ``` @@ -168,25 +174,28 @@ To install Qt: Example commands to build a default QGC and run it afterwards: 1. Make sure you cloned the repository and updated the submodules before, see chapter _Source Code_ above and switch into the repository folder: `cd qgroundcontrol` - ``` + + ```sh cd qgroundcontrol ``` 2. Create and enter a shadow build directory: - ``` + + ```sh mkdir build cd build ``` 3. Configure the build using the qmake script in the root of the repository: `qmake ../` - ``` + + ```sh 入门指南 ``` 4. Run make to compile and link. To accelerate the process things you can use the `-j{number of threads}` parameter. - ``` + ```sh `make -j12` ``` @@ -194,14 +203,15 @@ Example commands to build a default QGC and run it afterwards: You can also specify build time flags here. For example, you could disable airmap inclusion using the command: - ``` + ```sh DEFINES+=DISABLE_AIRMAP make build ``` ::: 5. Run the QGroundcontrol binary that was just built: `./staging/QGroundControl` - ``` + + ```sh ./staging/QGroundControl ``` diff --git a/docs/zh/qgc-dev-guide/tools/index.md b/docs/zh/qgc-dev-guide/tools/index.md index a2c4711..3945573 100644 --- a/docs/zh/qgc-dev-guide/tools/index.md +++ b/docs/zh/qgc-dev-guide/tools/index.md @@ -11,10 +11,6 @@ and accessing the System Shell over MAVLink. 工具包括： - 模拟链接（仅限每日构建） - 创建和停止多个模拟载具链接。 -- 重播飞行数据 - 重播遥测日志（用户指南）。 -- MAVLink Inspector - 显示收到的MAVLink消息/值。 -- MAVLink分析器 - 绘制MAVLink消息/值的趋势图。 -- 自定义命令小组件 - 在运行时加载自定义/测试QML UI。 -- **[Onboard Files](https://docs.qgroundcontrol.com/en/app_menu/onboard_files.html)** - Navigate vehicle file system and upload/download files. -- HIL Config Widget - HIL模拟器的设置. -- MAVLink控制台（仅限PX4） - 连接到PX4 nsh shell并发送命令。 +- **[Replay Flight Data](../../qgc-user-guide/fly_view/replay_flight_data.md)** - Replay a telemetry log (User Guide). +- **[MAVLink Inspector](../../qgc-user-guide/analyze_view/mavlink_inspector.html)** - Display received MAVLink messages/values and plot trends. +- **[MAVLink Console](../../qgc-user-guide/analyze_view/mavlink_console.html)** (PX4 Only) - Connect to the PX4 nsh shell and send commands. diff --git a/docs/zh/qgc-user-guide/index.md b/docs/zh/qgc-user-guide/index.md index a72034f..5856f39 100644 --- a/docs/zh/qgc-user-guide/index.md +++ b/docs/zh/qgc-user-guide/index.md @@ -23,5 +23,5 @@ The information provided should be correct, but you may find missing information ::: :::tip -关于 _QGroundControl_ 开发、架构、贡献和翻译的信息可在 [开发者指南](https://dev.qgroundcontrol.com/en/) 中找到。 +Information about _QGroundControl_ development, architecture, contributing, and translating can be found in the [Developer Guide](../qgc-dev-guide/index.md) section. ::: diff --git a/docs/zh/qgc-user-guide/releases/stable_v3.2_long.md b/docs/zh/qgc-user-guide/releases/stable_v3.2_long.md index 0056ad2..1d56f30 100644 --- a/docs/zh/qgc-user-guide/releases/stable_v3.2_long.md +++ b/docs/zh/qgc-user-guide/releases/stable_v3.2_long.md @@ -47,7 +47,7 @@ This is now supported from the Copy Trims button on the Radio setup page. Previous version of _QGroundControl_ saved missions, geo-fences and rally points in separate files (**.mission**, **.fence**, **.rally**). QGC now save all information related to a flight plan into a single file called a _Plan File_ with a file extension of **.plan**. -Information about the format can be found in [Plan File Format](https://dev.qgroundcontrol.com/en/file_formats/plan.html) (QGC Developer Guide). +Information about the format can be found in [Plan File Format](../../qgc-dev-guide/file_formats/plan.md) (QGC Developer Guide). ### Plan Toolbar diff --git a/docs/zh/qgc-user-guide/settings_view/console_logging.md b/docs/zh/qgc-user-guide/settings_view/console_logging.md index 3cfd225..e018df4 100644 --- a/docs/zh/qgc-user-guide/settings_view/console_logging.md +++ b/docs/zh/qgc-user-guide/settings_view/console_logging.md @@ -27,27 +27,37 @@ An alternate mechanism for logging is using the `--logging` command line option. How you do this and where the traces are output vary by OS: - Windows + - You must open a command prompt, change directory to the **qgroundcontrol.exe** location, and run it from there: bash cd "\Program Files (x86)\qgroundcontrol" qgroundcontrol --logging:full - ```bash + + ```sh cd "\Program Files (x86)\qgroundcontrol" qgroundcontrol --logging:full ``` + - When _QGroundControl_ starts you should see a separate console window open which will have the log output + - OSX + - You must run _QGroundControl_ from Terminal. The Terminal app is located in Applications/Utilities. Once Terminal is open paste the following into it: - ```bash + + ```sh Once Terminal is open paste the following into it: bash cd /Applications/qgroundcontrol.app/Contents/MacOS/ ./qgroundcontrol --logging:full ``` + - Log traces will output to the Terminal window. -- ## Linux - ```bash + +- Linux + + ```sh bash ./qgroundcontrol-start.sh --logging:full ``` + - Log traces will output to the shell you are running from.