diff options
| author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-08-27 16:46:22 +0900 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-08-27 16:46:22 +0900 |
| commit | 9cb69b0b8e8026581a538912bf6cb30e3cdaa325 (patch) | |
| tree | 1c8dc3c7a3954e444e6b47667e26ec04db55e3f5 | |
| parent | c6ba89322f741760747088b8b66516b686ae0ad0 (diff) | |
| download | buildstream-9cb69b0b8e8026581a538912bf6cb30e3cdaa325.tar.gz | |
doc/source/main_install.rst: Clarify that BuildStream cannot be run on Windows
The previous wording was misleading and caused one to think you can run
BuildStream on Windows, this commit fixes that and rewords the main section
heading to be a bit more abstract.
Fixes issue #608
| -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 |