From 5df15e1149314df3129e2deb6bdf4eb9ca0029fa Mon Sep 17 00:00:00 2001 From: Arkadiusz Hiler Date: Fri, 11 Jun 2021 17:39:47 +0300 Subject: [PATCH] README: Document the VM-less build. --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 31d1b85e..c469d33f 100644 --- a/README.md +++ b/README.md @@ -205,6 +205,29 @@ manually (see below), or automatically with `make install`. `make deploy` will package Proton up for distribution via Steamworks. +--- +Building without the VM +--- + +Since most of the build happens inside the Proton SDK container, building +without a VM should be mostly safe. It requires a working container engine +(Docker / Podman) and few command line tools. + +Running `configure.sh` will check if containers are functional and prompt you +if any dependencies are missing. + +The build by default uses Docker, but you can switch to another, compatible +engine with `--container-engine=`. + +You can enable ccache with `--enable-cache` flag. This will mount your +`$CCACHE_DIR` or `$HOME/.ccache` inside the container. + +Example: + + mkdir build && cd build + ../proton/configure.sh --container-engine=podman --enable-ccache + make dist + --- Install Proton locally ---