Pelote
FR
GitHub README

ReadmeKit

The GitHub README template: banner, badges, table of contents, sections, footer.

Category: GitHub READMEOpen the preview alone

Live preview

Reference specimen. Example copy comes from the Pelote specs and is in French.

READMEGabarit M3E, celui de vps-admin, sur les deux fonds de GitHub

GitHub · clairVPS Admin | Panel, déploiements et assistant pour tes serveurs Linux
GoVue 3Flutter 3.44Material YouSQLite
Aperçu · Fonctionnalités · Installation · Sécurité · Stack · Développement
VPS Admin est un panel auto-hébergé pour n'importe quel VPS Linux : agent Go, panel web Material 3 et app Flutter.
02 | Fonctionnalités
Contenu en Markdown : tableaux, blocs de code, détails repliables…
beedywool.com
GitHub · sombreVPS Admin | Panel, déploiements et assistant pour tes serveurs Linux
GoVue 3Flutter 3.44Material YouSQLite
Aperçu · Fonctionnalités · Installation · Sécurité · Stack · Développement
VPS Admin est un panel auto-hébergé pour n'importe quel VPS Linux : agent Go, panel web Material 3 et app Flutter.
02 | Fonctionnalités
Contenu en Markdown : tableaux, blocs de code, détails repliables…
beedywool.com

Ordre : banner, badges for-the-badge (4F378B / D0BCFF), sommaire, accroche en citation, séparateurs numérotés, contenu en Markdown, footer beedywool.com lié au site. Les images viennent tel quel de vps-admin/.github/assets.

UX / UIRègles illustrées

À faire
Le banner reprend exactement celui de vps-admin : seuls le nom, l'accroche, les chips et la capture changent.
À éviter
MON PROJET 🚀
Un banner improvisé (dégradé, emoji, capitales) hors du gabarit.
À faire
Footer beedywool.com toujours présent, en dernier, lié au site.
À éviter
Projet personnel.
Pas de footer : le README sort de la famille.
À faire
Le footer porte le nom ou la marque du projet dans sa pastille : beedywool.com pour les projets de l'auteur, le vôtre pour les vôtres (même mise en page, lien vers votre site).

Reference specimen. Example copy comes from the Pelote specs and is in French.

The GitHub README template for projects using Pelote, wired 1:1 to vps-admin's: banner, badges, table of contents, hook, numbered dividers and beedywool.com footer, in light and dark.

Rules

  • Copy vps-admin/tools/readme-assets.py and change only the data (name, tagline, chips, screenshot, sections).
  • One style per README, the app's. Always both themes, through <picture> and prefers-color-scheme.
  • The footer is always present, last, linked to https://beedywool.com. A project for another brand shows its own name.

More

TokensAssetsLicense GitHub

Appearance

The choice applies immediately and stays on this device.

Mode
Theme colour Every role is regenerated from this source colour.
Style The material changes, components and roles stay the same.
Material YouOn the web, the wallpaper colour is not available. Pick a source colour above; in Android 12+ apps, Material You follows the wallpaper.