Skip to content

Commit

Permalink
docs: add requirement to use VirtioFS
Browse files Browse the repository at this point in the history
  • Loading branch information
koehlma committed Jan 2, 2024
1 parent d9c9414 commit 421a98a
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion www/docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ git clone https://github.com/silitics/rugpi-template
Note that Rugpi Bakery is distributed as a Docker image (for `arm64` and `amd64`) because it relies on various Linux tools and facilities to build the image.
Building images outside of Docker is fundamentally only possible on Linux and not officially supported.
So, to build the image locally, a working Docker installation is required.
The template ships with a `run-bakery` shell script (for Linux and macOS) to run Rugpi Bakery in a temporary container.
On MacOS, make sure to use the [MacOS virtualization framework and VirtioFS](https://docs.docker.com/desktop/settings/mac/#general) (the default with recent versions of Docker Desktop).
The template ships with a `run-bakery` shell script (for Linux and MacOS) to run Rugpi Bakery in a temporary container.
For Windows, please run Rugpi Bakery inside WSL.

To print the usage instructions of Rugpi Bakery, in the root directory of the template, run:
Expand Down

0 comments on commit 421a98a

Please sign in to comment.