Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/en/qgc-dev-guide/firmware_plugin.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Plugin Architecture

Although the MAVLink spec defines a standard communication protocol to communicate with a vehicle. There are many aspects of that spec that are up for interpretation by the firmware developers. Because of this there are many cases where communication with a vehicle running one firmware is be slightly different than communication with a vehicle running a different firmware in order to accomplish the same task. Also each firmware may implement a different subset of the MAVLink command set.
Although the MAVLink spec defines a standard communication protocol to communicate with a vehicle. There are many aspects of that spec that are up for interpretation by the firmware developers. Because of this there are many cases where communication with a vehicle running one firmware is slightly different than communication with a vehicle running a different firmware in order to accomplish the same task. Also each firmware may implement a different subset of the MAVLink command set.

Another major issue is that the MAVLink spec does not cover vehicle configuration or a common parameter set. Due to this all code which relates to vehicle setup ends up being firmware specific. Also any code which must refer to a specific parameter is also firmware specific.

Expand Down
23 changes: 5 additions & 18 deletions docs/en/qgc-dev-guide/getting_started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,24 +17,11 @@ Versions are provided for all platforms.
Source code for _QGroundControl_ is kept on [GitHub](https://github.com/mavlink/qgroundcontrol).
It is [dual-licensed under Apache 2.0 and GPLv3](https://github.com/mavlink/qgroundcontrol/blob/master/.github/COPYING.md).

To get the source files:
To get the source files, clone the repo (or your fork):

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
```

:::tip
Github source-code zip files cannot be used because these do not contain the appropriate submodule source code.
You must use git!
:::
```sh
git clone -j8 https://github.com/mavlink/qgroundcontrol.git
```

## Build QGroundControl

Expand Down Expand Up @@ -131,7 +118,7 @@ When installing, select _Desktop development with C++_ as shown:

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:
1. Make sure you cloned the repository before, see chapter _Source Code_ above and switch into the repository folder:

```sh
cd qgroundcontrol
Expand Down
4 changes: 2 additions & 2 deletions docs/en/qgc-dev-guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ The translation projects (and join links) are listed below:

The PX4 Developer Guide contains additional information about the (common) docs/translation toolchain:

- [Documentation](https://dev.px4.io/en/contribute/docs.html)
- [Translation](https://dev.px4.io/en/contribute/docs.html)
- [Documentation](https://docs.px4.io/main/en/contribute/docs)
- [Translation](https://docs.px4.io/main/en/contribute/docs.html)

## License

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/qgc-dev-guide/getting_started/cent_os.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ Select the following options and install it under `~/devel/Qt`:
### Clone and Build QGC

```
git clone --recursive https://github.com/mavlink/qgroundcontrol.git
git clone https://github.com/mavlink/qgroundcontrol.git
mkdir build
cd build
```
Expand Down
Loading