From 1d2d947549d4f8b2c5998f9b367b5da48dbf6dcd Mon Sep 17 00:00:00 2001
From: Simon McVittie <smcv@collabora.com>
Date: Wed, 31 Jul 2019 18:40:37 +0100
Subject: [PATCH] README: Document how to use a Sdk runtime

Signed-off-by: Simon McVittie <smcv@collabora.com>
---
 README.md | 46 +++++++++++++++++++++++++++++++++-------------
 1 file changed, 33 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index aca7b1f31..38b83c6c7 100644
--- a/README.md
+++ b/README.md
@@ -209,6 +209,39 @@ Instructions for testing
             -C ~/.steam/steam/steamapps/common/SteamLinuxRuntime/pressure-vessel \
             -xzvf ~/pressure-vessel-*-bin.tar.gz
 
+* Put some Flatpak-style runtimes alongside pressure-vessel,
+    for example `~/.steam/steam/steamapps/common/SteamLinuxRuntime/scout`,
+    so that you have a
+    `~/.steam/steam/steamapps/common/SteamLinuxRuntime/scout/files/` directory
+    and a `~/.steam/steam/steamapps/common/SteamLinuxRuntime/scout/metadata`
+    file. For example, download a
+    `com.valvesoftware.SteamRuntime.Platform-amd64,i386-scout-runtime.tar.gz`
+    from http://repo.steampowered.com/steamrt/steamrt-scout/snapshots/ and
+    unpack it like this:
+
+        $ rm -fr ~/.steam/steam/steamapps/common/SteamLinuxRuntime/scout
+        $ mkdir -p ~/.steam/steam/steamapps/common/SteamLinuxRuntime/scout
+        $ tar \
+            -C ~/.steam/steam/steamapps/common/SteamLinuxRuntime/scout \
+            -xzvf ~/com.valvesoftware.SteamRuntime.Platform-amd64,i386-scout-runtime.tar.gz
+
+    Or to have a SDK environment with more debugging tools, and optionally
+    detached debugging symbols, download a
+    `com.valvesoftware.SteamRuntime.Platform-amd64,i386-scout-runtime.tar.gz`
+    and optionally a matching
+    `com.valvesoftware.SteamRuntime.Platform-amd64,i386-scout-debug.tar.gz`,
+    and unpack them like this:
+
+        $ rm -fr ~/.steam/steam/steamapps/common/SteamLinuxRuntime/scout_sdk
+        $ mkdir -p ~/.steam/steam/steamapps/common/SteamLinuxRuntime/scout_sdk
+        $ tar \
+            -C ~/.steam/steam/steamapps/common/SteamLinuxRuntime/scout_sdk \
+            -xzvf ~/com.valvesoftware.SteamRuntime.Sdk-amd64,i386-scout-runtime.tar.gz
+
+        $ tar --strip-components=1 \
+            -C ~/.steam/steam/steamapps/common/SteamLinuxRuntime/scout_sdk/files/lib/debug/ \
+            -xzvf ~/com.valvesoftware.SteamRuntime.Sdk-amd64,i386-scout-debug.tar.gz
+
 * Launch a game once without pressure-vessel
 
 * Configure the launch options for the chosen game. Either use the Steam
@@ -225,19 +258,6 @@ Instructions for testing
 
             "LaunchOptions" "~/.steam/steam/steamapps/common/SteamLinuxRuntime/pressure-vessel/bin/pressure-vessel-unruntime-test-ui -- %command%"
 
-    - optionally put some Flatpak-style runtimes alongside pressure-vessel,
-      for example `~/.steam/steam/steamapps/common/SteamLinuxRuntime/scout`.
-      If you have done it right, you should have
-      `~/.steam/steam/steamapps/common/SteamLinuxRuntime/scout/files/` and.
-      `~/.steam/steam/steamapps/common/SteamLinuxRuntime/scout/metadata`, for
-      example:
-
-            $ rm -fr ~/.steam/steam/steamapps/common/SteamLinuxRuntime/scout
-            $ mkdir -p ~/.steam/steam/steamapps/common/SteamLinuxRuntime/scout
-            $ tar \
-                -C ~/.steam/steam/steamapps/common/SteamLinuxRuntime/scout \
-                -xzvf ~/com.valvesoftware.SteamRuntime.Platform-amd64,i386-scout-runtime.tar.gz
-
     - restart Steam (on SteamOS use `sudo systemctl restart lightdm`)
 
         - TODO: Is there a scriptable way to make Steam edit `localconfig.vdf`
-- 
GitLab