Skip to content

docs: clarify requirements and add a troubleshooting check to the install guide - #29

Merged
afonsojramos merged 2 commits into
mainfrom
docs/clarify-install
Nov 2, 2026
Merged

afonsojramos merged 2 commits into
mainfrom
docs/clarify-install

Conversation

@afonsojramos

@afonsojramos afonsojramos commented Nov 2, 2026 •

Copy link
Copy Markdown
Member

Summary

  • State the real requirement (KWin 6 on Wayland) and that bars from other shells such as Caelestia work, and drop the tested-versions line.
  • Explain why Gitify's Use X11 backend setting should stay off.
  • Use Plasma 6's Get New… button name and note that Store updates arrive through it.
  • List Node 24+ and Python 3 for building the bundle.
  • Add a Check that it works section: what the popup should do, how to confirm the script is loaded, and why a keyboard open before the first tray click uses the fallback position.
  • Mention removing the script from KWin Scripts as an uninstall option.

Merge before #28 so the 1.0.0 release ships this README.

@afonsojramos
afonsojramos requested a review from setchy as a code owner November 2, 2026 01:31
@sonarqubecloud

sonarqubecloud Bot commented Nov 2, 2026

Copy link
Copy Markdown

@afonsojramos
afonsojramos merged commit 59aceae into main Nov 2, 2026
2 checks passed
@afonsojramos
afonsojramos deleted the docs/clarify-install branch November 2, 2026 01:36
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.

1 participant