Skip to content

Commit 9afee66

Browse files
committed
README: De-emphasize the scripts in this repository
Some of the scripts in this repository are still necessary when used internally (in particular, we still use `build-runtime.py` to build official scout releases), but third-party developers shouldn't normally need to run them, and they are not the same scripts that we use to build the container-based runtimes. Resolves: ValveSoftware#737 Signed-off-by: Simon McVittie <[email protected]>
1 parent 1988e9b commit 9afee66

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

README.md

+22-2
Original file line numberDiff line numberDiff line change
@@ -107,8 +107,6 @@ They can also be downloaded by opening `steam://` links with Steam:
107107

108108
All the software that makes up the Steam Runtime is available in both source and binary form in the Steam Runtime repository [https://repo.steampowered.com/steamrt](https://repo.steampowered.com/steamrt "")
109109

110-
Included in this repository are scripts for building local copies of the Steam Runtime for testing and scripts for building Linux chroot environments suitable for building applications.
111-
112110
[Steam Client for Linux]: https://github.com/ValveSoftware/steam-for-linux/
113111

114112
Building in the runtime
@@ -183,3 +181,25 @@ These apt repositories are preconfigured in the SDK container images.
183181

184182
A beta branch is also available for each suite.
185183
Please see the corresponding SDK documentation for more details.
184+
185+
Code in this repository
186+
-----------------------
187+
188+
This repository contains scripts for building local copies of the
189+
`LD_LIBRARY_PATH` Steam Runtime for testing.
190+
This is not usually necessary: using the official runtime is normally
191+
more appropriate.
192+
193+
This repository also contains scripts for building Linux chroot
194+
environments suitable for building applications.
195+
These scripts are deprecated,
196+
and are not usually necessary.
197+
Using the official container-based SDKs (see above) is recommended.
198+
199+
The container runtimes and the official container-based SDKs are not
200+
built using the scripts in this repository:
201+
instead,
202+
they are built using
203+
[flatdeb-steam](https://gitlab.steamos.cloud/steamrt/flatdeb-steam).
204+
It is not usually necessary for individual developers to rebuild these.
205+
Using the official container-based SDKs (see above) is recommended.

0 commit comments

Comments
 (0)