Skip to content

Commit ceff55d

Browse files
authored
Merge pull request #2061 from shymega-ct/domrodriguez/add-linux-disclaimer-docs
docs/README: Add note to make OS requirement clear
2 parents 71565ca + d582f46 commit ceff55d

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,10 @@ To get started, first `install BuildStream by following the installation guide
110110
and then follow our tutorial in the
111111
`user guide <https://docs.buildstream.build/master/main_using.html>`_.
112112

113+
Running BuildStream on macOS or Windows may work under Docker Desktop, WSL,
114+
or Podman Desktop, but it is not officially supported, and CI runs tests only on
115+
Linux.
116+
113117
We also recommend exploring some existing BuildStream projects:
114118

115119
* https://gitlab.gnome.org/GNOME/gnome-build-meta/

0 commit comments

Comments
 (0)