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

Added README.md with documentation #124

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

Conversation

Root-Core
Copy link
Contributor

I may have missed a few things, but I think this is a good starting point. I'm not a native speaker, so there might be some rough edges.

Feel free to improve and expand.

I also fixed some minor issues I encountered while writing the documentation.

Closes #122


> ~/.config/protonfixes/config.ini

It's not widely used at the moment, but you can configure some aspects.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. I doubt this feature is widely used too, so we should definitely consider deprecating this feature along with the GDrive functionality.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or we can add more config parameters and actually use that feature. Not sure yet.

README.md Show resolved Hide resolved
@R1kaB3rN
Copy link
Member

R1kaB3rN commented Sep 9, 2024

Yeah, it's a good starting point. Thanks.

Once I write something up, I'll try to merge this.


### Testing

The filenames of the fixes are checked against the Steam and GOG APIs. All symbolic links are also checked. This is not mandatory to run locally, as you should have a working game fix to begin with, and it will be done automatically by Github's CI.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Once we get more fixes related to other stores, it'd be nice to validate their store IDs against an API too. Or if there isn't an API, maybe query the game's store page if it includes the game's identifier in the URL like Steam's.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, I was just documenting the current state.

Loosely related, but I had some discussion about the other stores here: Open-Wine-Components/umu-database#39

@GloriousEggroll GloriousEggroll force-pushed the master branch 5 times, most recently from b457a0e to c47e5c3 Compare October 15, 2024 22:47
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.

Add Documentation
2 participants