Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/ValveSoftware/Proton.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArkadiusz Hiler <ahiler@codeweavers.com>2021-06-11 17:39:47 +0300
committerArkadiusz Hiler <ahiler@codeweavers.com>2021-06-16 10:50:08 +0300
commitcd3384f2afd529e758f10f3b03d9457faf01a47c (patch)
tree77e92e56686267d4c6bef943a7890ff465f78bfe
parent706d829acfbb04429a4279a5da46a138aa305181 (diff)
README: Document the VM-less build.
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
index f80d0538..92b008c2 100644
--- a/README.md
+++ b/README.md
@@ -206,6 +206,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=<executable_name>`.
+
+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
---
Steam ships with several versions of Proton, which games will use by default or