Skip to content

docs/README: Add note to make OS requirement clear #2061

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
shymega-ct wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs/README: Add note to make OS requirement clear #2061

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,10 @@ To get started, first `install BuildStream by following the installation guide
and then follow our tutorial in the
`user guide <https://docs.buildstream.build/master/main_using.html>`_.

Running BuildStream on macOS or Windows may work under Docker Desktop, WSL,
or Podman Desktop, but we only test in CI under Linux. but is not officially
supported.
Comment on lines +114 to +115
Copy link
Contributor

@juergbi juergbi Feb 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two 'but's and the end is not a complete sentence.

Suggested change
or Podman Desktop, but we only test in CI under Linux. but is not officially
supported.
or Podman Desktop, but it is not officially supported and CI runs tests only on Linux.

Or did you mean to remove the part after the second 'but' and it was left in by accident?


We also recommend exploring some existing BuildStream projects:

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