From 9cb69b0b8e8026581a538912bf6cb30e3cdaa325 Mon Sep 17 00:00:00 2001 From: Tristan Van Berkom Date: Mon, 27 Aug 2018 16:46:22 +0900 Subject: 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 --- doc/source/main_install.rst | 10 ++++++---- 1 file 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 ` .. toctree:: :maxdepth: 1 -- cgit v1.2.1