Added README.md with documentation #124
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.
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.
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.
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.
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
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