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
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
3 changes: 3 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,9 @@ 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 Windows is not supported, although WSL2 may result in
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Running Buildstream on Windows is not supported, although WSL2 may result in
Running BuildStream on Windows is not supported, although WSL2 may result in

some success; this workflow however, is not officially supporetd.
Copy link
Contributor

Choose a reason for hiding this comment

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

"may result in some success" is too unclear to me. WSL2 is essentially just Linux in a VM (+ a lot of integration work) and I would expect BuildStream to work fine in WSL2 but haven't tested it myself.

If there are known issues with BuildStream in WSL2, I would be less vague. If there are no known issues, I might formulate it something like:
"Running BuildStream on Windows is not supported. WSL2 may be used but is also not officially supported."


We also recommend exploring some existing BuildStream projects:

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