From b7f30d365fc742575c945a00ee89367833a224b0 Mon Sep 17 00:00:00 2001 From: Peter Barker Date: Fri, 22 Jan 2016 18:22:44 +1100 Subject: [PATCH] Document the use of Vagrant --- README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0601358b4..4d946f7ef 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,8 @@ git clone --recursive https://github.com/mavlink/qgroundcontrol.git Each time you pull new source to your repository you should run `git submodule update` to get the latest submodules as well. Since QGroundControl uses submodules, using the zip file for source download will not work. You must use git. ### Supported Builds + +#### Native Builds QGroundControl builds are supported for OSX, Linux, Windows 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. * OSX: OSX 10.7 or higher, 64 bit, clang compiler * Ubuntu: 64 bit, gcc compiler @@ -32,7 +34,7 @@ QGroundControl builds are supported for OSX, Linux, Windows and Android. QGround * Android: Jelly Bean (4.1) and higher * Qt version: 5.5.1 (or higher) -#### Install QT +###### 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. * Download the [Qt installer](http://www.qt.io/download-open-source) * 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. @@ -40,14 +42,14 @@ You need to install Qt like this instead of using packages from say a Linux dist -#### Install additional packages: +###### Install additional packages: * Ubuntu: sudo apt-get install espeak libespeak-dev libudev-dev libsdl1.2-dev * Fedora: sudo yum install espeak espeak-devel SDL-devel SDL-static systemd-devel * Arch Linux: pacman -Sy espeak * Windows: [USB Driver](http://www.pixhawk.org/firmware/downloads) to connect to Pixhawk/PX4Flow/3DR Radio * Android: [Qt Android Setup](http://doc.qt.io/qt-5/androidgs.html) -#### Building using Qt Creator +###### Building using Qt Creator * Launch Qt Creator and open the `qgroundcontrol.pro` project. * Select the appropriate kit for your needs: * OSX: Desktop Qt 5.5.1 clang 64 bit @@ -55,7 +57,16 @@ You need to install Qt like this instead of using packages from say a Linux dist * Windows: Desktop Qt 5.5.1 MSVC2013 32bit * Android: Android for armeabi-v7a (GCC 4.9, Qt 5.5.1) -### Additional build notes for all supported OS +#### Vagrant + +A Vagrantfile is provided to build QGroundControl using the [Vagrant](https://www.vagrantup.com/) system. This will produce a native Linux build which can be run in the Vagrant Virtual Machine or on the host machine if it is compatible. + +* [Download](https://www.vagrantup.com/downloads.html) Vagrant +* [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. -- 2.22.0