aboutsummaryrefslogtreecommitdiffstats
path: root/doc/qbs.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/qbs.qdoc')
-rw-r--r--doc/qbs.qdoc19
1 files changed, 13 insertions, 6 deletions
diff --git a/doc/qbs.qdoc b/doc/qbs.qdoc
index 42146ec6c..0e99d5dae 100644
--- a/doc/qbs.qdoc
+++ b/doc/qbs.qdoc
@@ -523,8 +523,12 @@
The easiest way to get started is to build \QBS using a Linux container. These types of
containers are supported out of the box on all the supported host platforms: Windows, macOS,
- and Linux. Run the following to download the \QBS development image based on Debian 9
- \e Stretch:
+ and Linux. The images provide everything that is necessary to build and test \QBS:
+
+ - Qt SDK for building \QBS with \c qmake
+ - Latest stable release of \QBS for building \QBS with \QBS
+
+ Run the following to download the \QBS development image based on Debian 9 \e Stretch:
\code
docker pull qbsbuild/qbsdev:stretch
@@ -534,16 +538,19 @@
machine's file system, by running:
\code
- docker run -it -v $PWD:/qbs -w /qbs qbsbuild/qbsdev:stretch
+ docker run -it -v ${PWD}:/qbs -w /qbs qbsbuild/qbsdev:stretch
\endcode
- Or with a slightly different syntax for Windows:
+ You will now be in an interactive Linux shell where you can develop and build \QBS.
+
+ For convenience, you can also run \c docker-compose from the project root directory:
\code
- docker run -it -v %CD%:/qbs -w /qbs qbsbuild/qbsdev:stretch
+ docker-compose run --rm stretch
\endcode
- You will now be in an interactive Linux shell where you can develop and build \QBS.
+ This will download and run the container in one go and mount the project root directory
+ to \c /qbs in the container.
\section2 Windows Containers