Pelote
EN
README GitHub

ReadmeAssets

Le kit d'images des README : banner, séparateur de section et 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.

M3EIdentique au README de vps-admin

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

Fichiers : m3e-banner-light.png, m3e-section-dark.png, m3e-footer-light.png…

PlazaWii U / 3DS, même mise en page

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

Fichiers : plaza-banner-light.png, plaza-section-dark.png, plaza-footer-light.png…

ChromeY2K, même mise en page

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

Fichiers : chrome-banner-light.png, chrome-section-dark.png, chrome-footer-light.png…

UX / UIRègles illustrées

À 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).
À faire
Un seul style du banner au footer, celui de l'app.
À éviter
Une section Chrome et un footer M3E dans le même README.
À faire
La version sombre avec #gh-dark-mode-only.
À éviter
La version claire affichée sur le thème sombre de GitHub.

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

Le kit d'images des README GitHub, sur l'exemple de vps-admin : banner (fenêtre inclinée avec la capture du panel), séparateur de section et footer beedywool.com, en trois styles (M3E, Plaza, Chrome), chacun en version claire et sombre. Les fichiers sont dans le groupe d'assets Readme.

Ce que fournit le consommateur

Le style de l'app, puis un tools/readme-assets.py qui génère les SVG du repo (banner avec sa propre capture, un séparateur par section) et le footer copié tel quel.

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.
  • M3E : la mise en page exacte de vps-admin/tools/readme-assets.py, sans variation.
  • Un seul style par README, celui de l'app.
  • Toujours les deux thèmes, appelés avec deux <img> et les fragments #gh-light-mode-only / #gh-dark-mode-only : GitHub suit son propre thème, pas celui de l'appareil.
  • Footer beedywool.com toujours présent, en dernier, lié à https://beedywool.com.

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.