-
Notifications
You must be signed in to change notification settings - Fork 44
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
base: master
Are you sure you want to change the base?
Conversation
|
||
> ~/.config/protonfixes/config.ini | ||
|
||
It's not widely used at the moment, but you can configure some aspects. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
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. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
b457a0e
to
c47e5c3
Compare
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