From e197e4f27e1f124b960f48040ca947705a08827b Mon Sep 17 00:00:00 2001 From: Gus Grubba Date: Fri, 10 Jun 2016 11:02:27 -0400 Subject: [PATCH] Update README.md Minor README tweaks. [ci skip] --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index cc62bc9d5..6a243dac9 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ Each time you pull new source to your repository you should run `git submodule u ### Supported Builds #### Native Builds -QGroundControl builds are supported for OSX, Linux, Windows, iOS and Android. QGroundControl uses [Qt](http://www.qt.io) as it's cross-platform support library and uses [QtCreator](http://doc.qt.io/qtcreator/index.html) as it's default build environment. +QGroundControl builds are supported for OSX, Linux, Windows, iOS and Android. QGroundControl uses [Qt](http://www.qt.io) as its cross-platform support library and uses [QtCreator](http://doc.qt.io/qtcreator/index.html) as its default build environment. * OSX: OSX 10.7 or higher, 64 bit, clang compiler * Ubuntu: 64 bit, gcc compiler * Windows: Vista or higher, 32 bit, [Visual Studio 2013 compiler](http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop) @@ -37,9 +37,9 @@ QGroundControl builds are supported for OSX, Linux, Windows, iOS and Android. QG * Qt version: 5.5.1 ONLY ###### Install QT -You need to install Qt like this instead of using packages from say a Linux distribution because QGroundControl needs access to private Qt headers. +You need to install Qt as described below instead of using pre-built packages from say, a Linux distribution because QGroundControl needs access to private Qt headers. * Download the [Qt installer](http://www.qt.io/download-open-source) - * Make sure to install Qt 5.5 version NOT 5.6 + * Make sure to install Qt version **5.5.1** NOT 5.4.x, 5.6.x, 5.7.x, etc. * Ubuntu: Set the downloaded file to executable using:`chmod +x`. Install to default location for use with ./qgroundcontrol-start.sh. If you install Qt to a non-default location you will need to modify qgroundcontrol-start.sh in order to run downloaded builds. * Windows: Default installer not quite correct, use [this](http://download.qt.io/official_releases/qt/5.5/5.5.1/qt-opensource-windows-x86-msvc2013-5.5.1.exe) instead @@ -57,7 +57,7 @@ You need to install Qt like this instead of using packages from say a Linux dist * Ubuntu: Desktop Qt 5.5.1 GCC bit * Windows: Desktop Qt 5.5.1 MSVC2013 32bit * Android: Android for armeabi-v7a (GCC 4.9, Qt 5.5.1) -* Note: iOS builds must be built using xCode: http://doc.qt.io/qt-5/ios-support.html +* Note: iOS builds must be built using xCode: http://doc.qt.io/qt-5/ios-support.html. Use Qt Creator to generate the XCode project (*Run Qmake* from the context menu). #### Vagrant @@ -67,11 +67,10 @@ A Vagrantfile is provided to build QGroundControl using the [Vagrant](https://ww * [Install](https://www.vagrantup.com/docs/getting-started/) Vagrant * From the root directory of the QGroundControl repository run "vagrant up" - #### Additional build notes for all supported OS -* Warnings as Errors: Specifying `CONFIG+=WarningsAsErrorsOn` will turn all warnings into errors which break the build. If you are working on a pull request you plan to submit to github for consideration, you should always run with this settings turned on, since it is required for all pull requests. NOTE: Putting this line into a file called "user_config.pri" in the top-level directory will set this flag on all builds without interfering with the GIT history. -* Parallel builds: You can use the '-j#' option to run parellel builds. +* Warnings as Errors: Specifying `CONFIG+=WarningsAsErrorsOn` will turn all warnings into errors which breaks the build. If you are working on a pull request you plan to submit to github for consideration, you should always run with this setting turned on, since it is required for all pull requests. NOTE: Putting this line into a file called "user_config.pri" in the top-level directory (same directory as `qgroundcontrol.pro`) will set this flag on all builds without interfering with the GIT history. +* Parallel builds: For non Windows builds, you can use the '-j#' option to run parellel builds. * Location of built files: Individual build file results can be found in the `build_debug` or `build_release` directories. The built executable can be found in the `debug` or `release` directory. * If you get this error when running qgroundcontrol: /usr/lib/x86_64-linux-gnu/libstdc++.so.6: version 'GLIBCXX_3.4.20' not found. You need to either update to the latest gcc, or install the latest libstdc++.6 using: sudo apt-get install libstdc++6. @@ -85,3 +84,6 @@ Integration with Opal-RT's RT-LAB simulator can be enabled on Windows by install QGroundControl can talk to XBee wireless devices using their proprietary protocol directly on Windows and Linux platforms. This support is not necessary if you're not using XBee devices or aren't using their proprietary protocol. On Windows, the necessary dependencies are included in this repository and no additional steps are required. For Linux, change to the `libs/thirdParty/libxbee` folder and run `make;sudo make install` to install libxbee on your system (uninstalling can be done with a `sudo make uninstall`). `qmake` will automatically detect the library on Linux, so no other work is necessary. To disable XBee support you may add `DEFINES+=DISABLE_XBEE` to qmake. + +### Video Streaming +Check the [Video Streaming](https://github.com/mavlink/qgroundcontrol/tree/master/src/VideoStreaming) directory for further instructions. -- 2.22.0