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

Improve Supported Platforms table #361

Closed
fohrloop opened this issue Jun 8, 2024 · 0 comments · Fixed by #365
Closed

Improve Supported Platforms table #361

fohrloop opened this issue Jun 8, 2024 · 0 comments · Fixed by #365
Assignees
Labels
Type: Documentation Improvements or additions to documentation

Comments

@fohrloop
Copy link
Owner

fohrloop commented Jun 8, 2024

The current Supported Platforms table lists

  • Platform (Windows, macOS, GNOME, KDE Plasma,...)
  • Methods
  • Modes

It could be improved by

  • Renaming "Platform" into "Runtime environment" to underline that this is where code is executed
  • Adding "Keepawake target system" or similar column telling which system it is targeting to keep awake -- Edit: This info seems repetitive. Probably the "Runtime environment" is enough.
  • Adding rows for Methods that are not implemented but are under consideration (and have a GitHub Issue). This would make the roadmap / future of wakepy more visible and could attract potential contributors. -- Edit: Decided to create separate table.
  • Adding examples of distros/OSes for different DEs. This would make searchability a bit better. - Edit: decided not to. Updating the DE <-> distro mappings would work. Hopefully the wikipedia links are enough.

New table mockup:

| Runtime environment        | Keepawake target system | Methods                         | Modes|
|----------------------------|-------------------------|---------------------------------|------|
| Windows                    | Windows                 | SetThreadExecutionState         |      |
| WSL                        | Windows                 | wakepy/#NN                      |      |
| cygwin                     | Windows                 | wakepy/#NN                      |      |
| macOS                      | macOS                   | caffeinate                      |      |
| Unix w/ Gnome              | Unix                    | org.gnome.SessionManager        |      | 
| Unix w/ KDE Plasma         | Unix                    | org.freedesktop.PowerManagement |      |
| Unix w/ Cinnamon           | Unix                    | wakepy/#NN                      |      |
| Unix w/ Xfce               | Unix                    | wakepy/#NN                      |      |
| Unix w/ Mate               | Unix                    | wakepy/#NN                      |      |
| Unix w/ LXQt               | Unix                    | wakepy/#NN                      |      |
| Android                    | Android                 | wakepy/#NN                      |      |
| Hosted Jupyter NB          | Any                     | wakepy/#NN                      |      |
| Browser                    | Any                     | wakepy/#NN                      |      |

(Unix would mean Unix-like)

@fohrloop fohrloop added the Type: Documentation Improvements or additions to documentation label Jun 8, 2024
@fohrloop fohrloop self-assigned this Jun 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant