Skip to content

Commit 2c90d73

Browse files
FabioDevCodeFabioDevCode
committed
docs: add README Fr & En
1 parent 1922a8d commit 2c90d73

3 files changed

Lines changed: 333 additions & 99 deletions

File tree

‎.github/workflows/update-stats.yml‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
name: Update GitHub Stats
22

33
on:
4-
# S'exécute tous les lundis à 00:00 UTC
54
schedule:
65
- cron: "0 0 * * 1"
76

8-
# Permet de lancer manuellement depuis l'onglet Actions
97
workflow_dispatch:
108

119
jobs:

‎README.fr.md‎

Lines changed: 231 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,231 @@
1+
# GitHub Stats Generator
2+
3+
[EN - README in English](README.md)
4+
5+
Générez automatiquement des images SVG de vos statistiques GitHub et intégrez-les dans n'importe quel README.
6+
7+
Ce projet fonctionne entièrement via **GitHub Actions** : aucune installation locale requise. Les images sont générées automatiquement selon la fréquence de votre choix et hébergées sur **GitHub Pages**, accessibles par URL publique.
8+
9+
## 🎯 Résultat
10+
11+
Ce projet génère automatiquement des images SVG affichant vos statistiques GitHub et les langages les plus utilisés.
12+
13+
- `stats-top4.svg` - Top 4 langages
14+
- `github-stats.svg` - Statistiques globales GitHub
15+
16+
### Exemples :
17+
18+
<div style="display: inline-block" align="left">
19+
<img height="180px" src="https://fabiodevcode.github.io/github-stats/stats-top4.svg"/>
20+
<img height="180px" src="https://fabiodevcode.github.io/github-stats/github-stats.svg"/>
21+
</div>
22+
23+
## 🚀 Installation
24+
25+
### 1. Cloner le repository
26+
27+
```bash
28+
# Cloner le projet
29+
git clone https://github.com/FabioDevCode/github-stats.git
30+
cd github-stats
31+
32+
# Supprimer les fichiers SVG existants (ils seront regénérés avec vos stats)
33+
rm -f *.svg
34+
```
35+
36+
### 2. Vérifier la structure du projet
37+
38+
Après le clone, vérifiez que la structure suivante est bien présente :
39+
40+
```
41+
github-stats/
42+
├── .github/
43+
│ └── workflows/
44+
│ └── update-stats.yml
45+
├── config.json
46+
├── generate-stats.js
47+
├── github_colors.json
48+
└── README.md
49+
```
50+
51+
### 3. Modifier la configuration
52+
53+
Dans `config.json`, modifiez les valeurs selon vos besoins :
54+
55+
```json
56+
{
57+
"USERNAME": "votre-username",
58+
"TITLE": "Top Languages",
59+
"STATS_TITLE": "GitHub Stats",
60+
"BG_COLOR": "#202830",
61+
"BORDER_COLOR": "#202830",
62+
"TITLE_COLOR": "#D1D7E0",
63+
"TEXT_COLOR": "#D1D7E0",
64+
"PERCENT_COLOR": "#9298A1",
65+
"ICON_COLOR": "#6e7681",
66+
"VALUE_COLOR": "#41B883",
67+
"VARIANTS": [2, 4, 6],
68+
"IGNORE_LANGUAGES": ["HTML", "CSS", "Handlebars", "SCSS"]
69+
}
70+
```
71+
72+
> 📝 **Note :** Consultez la section [Options disponibles](#options-disponibles) pour la description complète de chaque paramètre.
73+
74+
### 4. Créer un token GitHub
75+
76+
1. Allez sur GitHub → Settings → Developer settings → Personal access tokens → Tokens (classic)
77+
2. Cliquez sur "Generate new token (classic)"
78+
3. Nom : `GitHub Stats`
79+
4. Cochez les permissions :
80+
- ✅ `repo` (tous les sous-items)
81+
- ✅ `read:user`
82+
5. Générez et **copiez le token** (vous ne le reverrez plus !)
83+
84+
### 5. Ajouter le token au repository
85+
86+
1. Dans votre repo GitHub → Settings → Secrets and variables → Actions
87+
2. Cliquez sur "New repository secret"
88+
3. Name : `GH_TOKEN`
89+
4. Secret : collez votre token
90+
5. Cliquez sur "Add secret"
91+
92+
### 6. Activer GitHub Pages
93+
94+
1. Repository Settings → Pages
95+
2. Source : Deploy from a branch
96+
3. Branch : `main` / `/ (root)`
97+
4. Cliquez sur "Save"
98+
99+
### 7. Premier lancement
100+
101+
Deux options :
102+
103+
**Option A - Automatique :**
104+
105+
```bash
106+
git add .
107+
git commit -m "Initial setup"
108+
git push
109+
```
110+
111+
**Option B - Manuel :**
112+
113+
1. Allez dans l'onglet "Actions" de votre repo
114+
2. Cliquez sur le workflow "Update GitHub Stats"
115+
3. Cliquez sur "Run workflow"
116+
117+
## 📝 Utilisation
118+
119+
Une fois déployé, vos images seront disponibles aux URLs :
120+
121+
```
122+
https://votre-username.github.io/github-stats/stats-top2.svg
123+
https://votre-username.github.io/github-stats/stats-top4.svg
124+
https://votre-username.github.io/github-stats/stats-top6.svg
125+
https://votre-username.github.io/github-stats/github-stats.svg
126+
```
127+
128+
> **Note :** Les fichiers `stats-topN.svg` dépendent de la configuration `VARIANTS` dans `config.json`. Le fichier `github-stats.svg` affiche vos statistiques globales (stars, commits, PRs, issues, contributions).
129+
130+
### Dans un README :
131+
132+
```markdown
133+
![Top Languages](https://votre-username.github.io/github-stats/stats-top4.svg)
134+
![Top Languages](https://votre-username.github.io/github-stats/github-stats.svg)
135+
```
136+
137+
### En HTML :
138+
139+
```html
140+
<img
141+
src="https://votre-username.github.io/github-stats/stats-top4.svg"
142+
alt="Top Languages"
143+
/>
144+
<img
145+
src="https://votre-username.github.io/github-stats/github-stats.svg"
146+
alt="Github Stats"
147+
/>
148+
```
149+
150+
## ⚙️ Configuration
151+
152+
Toute la configuration se fait dans le fichier `config.json` :
153+
154+
```json
155+
{
156+
"USERNAME": "votre-username",
157+
"TITLE": "Top Languages",
158+
"STATS_TITLE": "GitHub Stats",
159+
"BG_COLOR": "#202830",
160+
"BORDER_COLOR": "#202830",
161+
"TITLE_COLOR": "#D1D7E0",
162+
"TEXT_COLOR": "#D1D7E0",
163+
"PERCENT_COLOR": "#9298A1",
164+
"ICON_COLOR": "#6e7681",
165+
"VALUE_COLOR": "#41B883",
166+
"VARIANTS": [2, 4, 6],
167+
"IGNORE_LANGUAGES": ["HTML", "CSS", "Handlebars", "SCSS"]
168+
}
169+
```
170+
171+
### Options disponibles
172+
173+
| Option | Description | Exemple |
174+
| ------------------ | ------------------------------------ | --------------------- |
175+
| `USERNAME` | Votre nom d'utilisateur GitHub | `"FabioDevCode"` |
176+
| `TITLE` | Titre du SVG des langages | `"Langages Utilisés"` |
177+
| `STATS_TITLE` | Titre du SVG des stats globales | `"GitHub Stats"` |
178+
| `BG_COLOR` | Couleur de fond | `"#202830"` |
179+
| `BORDER_COLOR` | Couleur de la bordure | `"#202830"` |
180+
| `TITLE_COLOR` | Couleur du titre | `"#D1D7E0"` |
181+
| `TEXT_COLOR` | Couleur du texte | `"#D1D7E0"` |
182+
| `PERCENT_COLOR` | Couleur des pourcentages (langages) | `"#9298A1"` |
183+
| `ICON_COLOR` | Couleur des icônes (stats globales) | `"#6e7681"` |
184+
| `VALUE_COLOR` | Couleur des valeurs (stats globales) | `"#41B883"` |
185+
| `VARIANTS` | Variantes à générer (top N langages) | `[2, 4, 6, 8]` |
186+
| `IGNORE_LANGUAGES` | Langages à exclure des stats | `["HTML", "CSS"]` |
187+
188+
### Changer la fréquence de mise à jour
189+
190+
Dans `.github/workflows/update-stats.yml`, remplacez la valeur `cron` par l'une des options suivantes selon vos besoins :
191+
192+
```yaml
193+
schedule:
194+
- cron: "0 0 * * *" # Tous les jours à minuit
195+
- cron: "0 */6 * * *" # Toutes les 6 heures
196+
- cron: "0 0 * * 1" # Tous les lundis
197+
```
198+
199+
> 💡 La fréquence par défaut est définie dans ce fichier. Conservez une seule ligne `- cron:` active à la fois.
200+
201+
### Couleurs des langages
202+
203+
Les couleurs des langages sont définies dans `github_colors.json`. Ce fichier contient les couleurs officielles GitHub pour chaque langage. Vous pouvez le modifier si nécessaire.
204+
205+
## 🐛 Dépannage
206+
207+
### L'action échoue
208+
209+
1. Vérifiez que le token `GH_TOKEN` est bien configuré
210+
2. Vérifiez que le `USERNAME` dans `config.json` est correct
211+
3. Consultez les logs dans l'onglet "Actions"
212+
213+
### Les images ne s'affichent pas
214+
215+
1. Attendez 2-3 minutes après le premier push (déploiement GitHub Pages)
216+
2. Vérifiez que GitHub Pages est activé dans Settings
217+
3. Vérifiez l'URL : `https://votre-username.github.io/nom-du-repo/stats-top4.svg`
218+
219+
### Forcer une mise à jour manuelle
220+
221+
1. Onglet "Actions"
222+
2. "Update GitHub Stats"
223+
3. "Run workflow"
224+
225+
## 📄 Licence
226+
227+
Ce projet est distribué sous licence [MIT](LICENSE). Vous êtes libre de l'utiliser, le modifier et le redistribuer.
228+
229+
---
230+
231+
**Note :** Les dépôts forkés sont exclus du calcul des statistiques. La fréquence de mise à jour est configurable, voir la section [Changer la fréquence de mise à jour](#changer-la-fréquence-de-mise-à-jour).

0 commit comments

Comments
 (0)