diff options
| author | Tristan Van Berkom <tristan.van.berkom@gmail.com> | 2018-08-27 08:12:52 +0000 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.van.berkom@gmail.com> | 2018-08-27 08:12:52 +0000 |
| commit | 8c7fadd81f39a157bc2efe5ce605d199396f4791 (patch) | |
| tree | 1c8dc3c7a3954e444e6b47667e26ec04db55e3f5 | |
| parent | c6ba89322f741760747088b8b66516b686ae0ad0 (diff) | |
| parent | 9cb69b0b8e8026581a538912bf6cb30e3cdaa325 (diff) | |
| download | buildstream-8c7fadd81f39a157bc2efe5ce605d199396f4791.tar.gz | |
Merge branch 'tristan/install-guide-main' into 'master'
doc/source/main_install.rst: Clarify that BuildStream cannot be run on Windows
Closes #608
See merge request BuildStream/buildstream!739
| -rw-r--r-- | doc/source/main_install.rst | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/source/main_install.rst b/doc/source/main_install.rst index a52c81512..80fe497ae 100644 --- a/doc/source/main_install.rst +++ b/doc/source/main_install.rst @@ -4,13 +4,15 @@ Install ======= -This section covers how to install BuildStream onto your machine, how to run -BuildStream inside a docker image and also how to configure an artifact server. +This section provides instructions for installing BuildStream and its +companion artifact server on various platforms, along with any installation +related materials. .. note:: - BuildStream is not currently supported natively on macOS and Windows. Windows - and macOS users should refer to :ref:`docker`. + BuildStream is currently only supported natively on Linux. Users of Unix-like + systems where Docker is available can still use BuildStream by following the + :ref:`Docker install guide <docker>` .. toctree:: :maxdepth: 1 |