Pelote
EN
README GitHub

ReadmeKit

Le gabarit des README GitHub : banner, badges, sommaire, sections, footer.

Catégorie: README GitHubOuvrir l'aperçu seul

Aperçu en direct

Spécimen de référence. Le contenu des exemples est celui des fiches Pelote, en français.

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).

Spécimen de référence. Le contenu des exemples est celui des fiches Pelote, en français.

Le gabarit des README GitHub des projets qui utilisent Pelote, câblé 1:1 sur celui de vps-admin : banner, badges, sommaire, accroche, séparateurs numérotés et footer beedywool.com, en version claire et sombre.

Ce que fournit le consommateur

Une copie de vps-admin/tools/readme-assets.py adaptée au projet (nom, accroche, chips, capture, liste des sections), qui écrit les SVG dans .github/assets/, et le README qui les appelle avec deux <img> et les fragments #gh-light-mode-only / #gh-dark-mode-only.

Règles

  • Le footer affiche beedywool.com parce que ces exemples sont des projets personnels ; un projet d'une autre marque y met son propre nom ou sa marque.
  • Mise en page M3E identique à vps-admin ; seules les données changent.
  • Footer beedywool.com toujours présent, dernier élément, lié à https://beedywool.com.
  • Détails complets : section README GitHub du guide.

Plus

TokensAssetsLicence GitHub

Apparence

Le choix s'applique tout de suite et reste sur cet appareil.

Mode
Couleur du thème Tous les rôles sont régénérés depuis cette couleur source.
Style La matière change, les composants et les rôles restent les mêmes.
Material YouSur le web, la couleur du fond d'écran n'est pas accessible. Choisis une couleur source ci-dessus ; dans les apps Android 12+, Material You suit le fond d'écran.