diff options
| author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2017-09-15 11:12:28 +0200 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2017-09-15 12:30:21 +0000 |
| commit | 4930e27df0d3d9faac0c4735ef98e6f747a951e5 (patch) | |
| tree | 7760177c0cd726bba27726d62cb95c3101a7c662 /doc/qbs.qdoc | |
| parent | c99d76a10bdb54b3ed2e7caaffaf580b9603c134 (diff) | |
Doc: Update supported platforms and build requirements
- Synchronize required versions of tools with Qt Creator 4.4, where
applicable.
- List currently tested platforms.
- Move the instructions from the README to the Qbs Manual and add the
URL to product documentation.
Task-number: QBS-1071
Change-Id: I5d710972bd6b686b18f02a1bd7db5e8356e09b7a
Reviewed-by: Jake Petroules <jake.petroules@qt.io>
Reviewed-by: Kai Koehne <kai.koehne@qt.io>
Diffstat (limited to 'doc/qbs.qdoc')
| -rw-r--r-- | doc/qbs.qdoc | 39 |
1 files changed, 37 insertions, 2 deletions
diff --git a/doc/qbs.qdoc b/doc/qbs.qdoc index 3185053ca..73d2e6929 100644 --- a/doc/qbs.qdoc +++ b/doc/qbs.qdoc @@ -339,9 +339,34 @@ \title Appendix A: Building Qbs + \QBS can be \l{Installing}{installed from binary packages} or built from + sources, as described in this appendix. In addition, this appendix describes + how to use Docker images for developing \QBS. + + \section1 Supported Platforms + + \QBS can be installed and run on the following platforms: + + \list + \li Windows 7, or later + \li Linux (tested on Debian 8 and 9, Ubuntu 16.04, OpenSuSE 13.2, and + Arch Linux) + \li macOS 10.7, or later + \endlist + \section1 System Requirements - To build \QBS from the source, you need Qt 5.6.0, or later + To build \QBS from the source, you need: + + \list + \li Qt 5.6.2, or later + \li Windows: MinGW with GCC 4.9 or Microsoft Visual Studio 2015, + or later + \li Linux: GCC 4.9, or later, or Clang 3.9.0, or later + \li macOS: Xcode 6.2, or later + \endlist + + An installed toolchain has to match the one that Qt was compiled with. \section1 Building @@ -351,6 +376,16 @@ qmake -r qbs.pro && make \endcode + Depending on your platform, you might use \c mingw32-make, \c nmake, or + \c jom instead of \c make. + + Installation by using \c {make install} is usually not needed. It is however + possible, by entering the following command. + + \code + make install INSTALL_ROOT=$INSTALL_DIRECTORY + \endcode + \section1 Configure Options \QBS recognizes the following qmake CONFIG options to customize the build: @@ -368,7 +403,7 @@ implies a dependency to the Qt GUI module. \endtable - \section1 Docker + \section1 Using Docker A set of Docker images for developing \QBS (which are maintained by the \QBS team) is available \l{https://hub.docker.com/u/qbsbuild/}{on Docker Hub}. |