Skip to content

docs(readme): reorder for first-time visitors, add comparison and settings table - #27

Merged
Roddygithub merged 1 commit into
mainfrom
docs/readme-rewrite
Oct 1, 2026
Merged

Roddygithub merged 1 commit into
mainfrom
docs/readme-rewrite

Conversation

@Roddygithub

Copy link
Copy Markdown
Owner

Réécriture complète du README pour un visiteur qui arrive de GitHub (topic page ou recherche).

Ce qui change

Ordre — avant : 100 lignes de build avant de savoir à quoi ça ressemble, et une section Overview qui répétait l'intro presque mot pour mot. Maintenant : intro → highlights → comparatif → install (4 lignes) → usage → configuration → systemd → build manuel → architecture/protocole.

Ajouts

  • Sommaire Contents (15 liens d'ancrage, validés via l'API GFM : 4 tables, 0 lien cassé)
  • Section How it compares avec Overlayed (Tauri), Discover (Python/GTK3, X11 + wlroots), DiscordOverlayLinux (Python/Qt, X11) — faits vérifiés depuis leurs propres READMEs, aucune affirmation non vérifiable
  • Badge Downloads
  • Table des settings du plugin

Corrections d'obsolescence

  • monitor documenté (absent depuis feat(overlay): let the user pick which monitor shows the overlay #26)
  • Racine de l'arborescence vesktop-voice-overlay/ → discord-voice-overlay/
  • Note compositors : multi-monitor est maintenant configurable, reste non validé sur un vrai multi-head
  • layer_shell.rs : mention de la résolution de moniteur ; docs/installer.md ajouté à l'arbre
  • Caveat « pas publié sur l'AUR » déplacé du quick start vers Distribution

Pas inclus

Capture/GIF hero — volontairement reporté, laissé en commentaire HTML pour garder le haut du README propre tant qu'il n'y a pas d'asset.

La social preview du dépôt (openGraphImageUrl) est toujours vide : à régler dans Settings → Social preview.

…tings table

- Contents anchors, highlights before install, usage before build
- How it compares: Overlayed/Discover/DiscordOverlayLinux, verified stacks
- Settings table documents monitor (added in #26)
- Downloads badge; stale root dir name and multi-monitor note fixed
- Move the 'not published in AUR' caveat into Distribution
@Roddygithub
Roddygithub merged commit 850989c into main Oct 1, 2026
6 checks passed
@Roddygithub
Roddygithub deleted the docs/readme-rewrite branch October 1, 2026 22:31
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