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

readme: document utilities and post-Wayland backend refactor cleanup #1538

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

matte-schwartz
Copy link

@matte-schwartz matte-schwartz commented Sep 21, 2024

work-in-progress readme makeover to account for all of the gamescope additions and changes in the past year or so. Will be revising and proofreading this a bit further plus adding a few more sections before marking this ready for review.

I may move the build deps/run-time requirement stuff to a separate wiki page similar to https://wiki.fex-emu.com/index.php/Development:Setting_up_FEX just to keep this cleaner, and only keeping the basic compilation instructions on the main page. Maybe moving the detailed sections into here: https://github.com/ValveSoftware/gamescope/wiki/Distribution-specific-instructions or https://github.com/ValveSoftware/gamescope/wiki#build makes more sense?

issue template will be separate.

@matte-schwartz matte-schwartz force-pushed the readme2-electricboogaloo branch 10 times, most recently from 3d96281 to 6c93150 Compare October 19, 2024 05:50
@matte-schwartz matte-schwartz changed the title readme: build out and update readme sections to account for Wayland backend refactor readme: document utilities and post-Wayland backend refactor cleanup Oct 19, 2024
@matte-schwartz matte-schwartz marked this pull request as ready for review October 19, 2024 06:01
@matte-schwartz
Copy link
Author

matte-schwartz commented Oct 19, 2024

ready for review, feel free to make nits before or after merge.

one note - i've temporarily removed the step about running gamescope builds from within the build directory itself pending a fix to #1539

I can add in the correct method for running local gamescope once fixed, or we can just recommend installing to /usr/local and then uninstalling afterwards.

edit: force pushed for some grammar nits in the mangoapp section

People previously reported that the suggested launch arguments would
work without using `--` before `%command%` or an application. This was
unintentional behavior, and a recent Steam stable client update has made
this method no longer function.

Let's add a clear warning to the readme to point people towards in case
of any confusion.
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.

1 participant