Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation updates, drop vestigial support for heavy #740

Merged
merged 9 commits into from
Jan 28, 2025

Conversation

smcv
Copy link
Contributor

@smcv smcv commented Jan 27, 2025

  • README: Ubuntu 14.04 no longer works, mention 16.04 instead

    Ubuntu 16.04 is the minimum version since steam-launcher 1.0.0.76.

  • README: Link to Steam Runtime SDK docs instead of repeating ourselves

    Adding and updating detailed documentation in this repository is
    inconvenient, because for historical reasons its git history contains
    large binaries, which cannot be removed without invalidating branches
    and forks of the repository.

    Each branch of the Steam Runtime has its own SDK hosted elsewhere,
    so link to those as the primary thing to use.

  • README: Mention Distrobox as an alternative to Toolbx

    Either one should usually work equally well.

    Resolves: Add setup documentation for distrobox #739

  • Update introduction to reflect reality as of early 2025

    • Native sniper games are now recommended
    • Legacy scout games now run in SLR 1.0 by default
    • Legacy scout games can be told to run in the legacy LDLP runtime
  • Update introduction to reflect Proton status in early 2025

    We never updated this when Proton 8 switched to sniper. Do so now.

  • README: De-emphasize the apt repositories

    The official SDK container images are normally preferable to accessing
    the apt repositories directly, and they contain the apt repositories
    as preconfigured apt sources.

  • 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: flatdeb-steam documentation to build sniper is out of date #737

  • build-runtime.py: Remove references to heavy

    We no longer build or use Steam Runtime 1½ 'heavy'.

  • build-runtime: Make it clearer that this is not used for sniper, etc.

    Resolves: flatdeb-steam documentation to build sniper is out of date #737


HTML preview: https://github.com/smcv/steam-runtime/blob/wip/only-scout/README.md

smcv added 9 commits January 27, 2025 13:32
Ubuntu 16.04 is the minimum version since steam-launcher 1.0.0.76.

Signed-off-by: Simon McVittie <[email protected]>
Adding and updating detailed documentation in this repository is
inconvenient, because for historical reasons its git history contains
large binaries, which cannot be removed without invalidating branches
and forks of the repository.

Each branch of the Steam Runtime has its own SDK hosted elsewhere,
so link to those as the primary thing to use.

Signed-off-by: Simon McVittie <[email protected]>
Either one should usually work equally well.

Resolves: ValveSoftware#739
Signed-off-by: Simon McVittie <[email protected]>
- Native sniper games are now recommended
- Legacy scout games now run in SLR 1.0 by default
- Legacy scout games can be told to run in the legacy LDLP runtime

Signed-off-by: Simon McVittie <[email protected]>
We never updated this when Proton 8 switched to sniper. Do so now.

Signed-off-by: Simon McVittie <[email protected]>
The official SDK container images are normally preferable to accessing
the apt repositories directly, and they contain the apt repositories
as preconfigured apt sources.

Signed-off-by: Simon McVittie <[email protected]>
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]>
We no longer build or use Steam Runtime 1½ heavy'.

Signed-off-by: Simon McVittie <[email protected]>
@smcv smcv marked this pull request as ready for review January 27, 2025 16:00
@smcv
Copy link
Contributor Author

smcv commented Jan 27, 2025

cc @TTimo

@smcv smcv changed the title Documentation updates Documentation updates, drop vestigial support for heavy Jan 27, 2025
@TTimo
Copy link
Collaborator

TTimo commented Jan 27, 2025

Looks good - is this ready to merge or you are planning more updates?

@smcv
Copy link
Contributor Author

smcv commented Jan 27, 2025

This is ready to merge. At some point I might remove setup_chroot.sh completely, but that can be a followup (and I'll need to make sure deb-build-snapshot works well with podman/Toolbx first).

@TTimo TTimo merged commit 6e15b7c into ValveSoftware:master Jan 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

flatdeb-steam documentation to build sniper is out of date Add setup documentation for distrobox
2 participants