bottlesdevs / Bottles

Run Windows software and games on Linux
https://usebottles.com
GNU General Public License v3.0
6.21k stars 258 forks source link

[Bug]: Incomplete Runners section in documentation #3035

Open drws opened 1 year ago

drws commented 1 year ago

Describe the bug

Going through the documentation there are few (if any) mentions of Soda and Wine-GE. On the other hand both are in the first spots of the list in Preferences > Runners. They should be explained in the Runners section of the documentation. To make a clear comparison between numerous similar runners, a feature matrix could be added to the Runners section. A draft:

RUNNER    | TYPE   | BASED ON      | PATCHES
----------|--------|---------------|----------------
Caffe     | Wine   | wine-upstream | staging, Proton
Lutris    | Wine   | wine-upstream | ?
Proton-GE | Proton | proton        | staging, Steam
Soda      | Proton | proton        | staging
Vaniglia  | Wine   | wine-upstream | staging
Wine      | Wine   |               | 
Wine-GE   | Wine   | proton        | ?

To Reproduce

  1. Read the Runners section of documentation

Package

Flatpak from Flathub

Distribution

Arch Linux

Debugging Information

no debug info

Troubleshooting Logs

No response

Additional context

No response

orowith2os commented 1 year ago

PRs welcome.

Perkolator commented 1 year ago

Unfortunately the documentation, not just for runners, is outdated. Also still has some sections that are "under construction". It's a pity since it's the foremost guide to new users.. but I understand that writing/updating documentation is probably the least favorite thing to do for many people.

ghost commented 1 year ago

I've just submitted a pull request to update the Runner docs with new information at https://github.com/bottlesdevs/documentation/pull/49. Hopefully it covers more bases now that we have a whole plethora of runners to choose from. (Also feel free to correct any inaccuracies, as I cobbled the revision together in an ad-hoc fashion and some errors might've snuck in.