Skip to content

Commit 3ad9f9d

Browse files
committed
docs: finalize README content
1 parent e6fbfd0 commit 3ad9f9d

1 file changed

Lines changed: 30 additions & 21 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 30 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,46 @@
11
# Nicolas Genty β€” Portfolio
22

3-
Un portfolio haute performance, minimaliste et brutaliste. PropulsΓ© par **Astro 5** avec une architecture orientΓ©e donnΓ©es.
3+
A high-performance, minimalist, and brutalist portfolio. Powered by **Astro 5** with a data-driven architecture.
44

5-
## πŸš€ FonctionnalitΓ©s ClΓ©s
5+
## Key Features
66

7-
- **Architecture Astro 5** : Performance statique maximale.
8-
- **Système de Thème Avancé** : Transition fluide (View Transitions) avec persistance.
9-
- **Design System** : Design tokens centralisΓ©s (`tokens.css`).
10-
- **Content-First** : Gestion des contenus via fichiers JSON typΓ©s.
11-
- **Asset Optimization** : Auto-hΓ©bergement des polices et icΓ΄nes.
7+
- **Astro 5 Architecture**: Maximum static performance.
8+
- **Advanced Theme System**: Smooth transitions (View Transitions) with persistence.
9+
- **Design System**: Centralized design tokens (`tokens.css`).
10+
- **Content-First**: Content management via typed JSON files.
11+
- **Asset Optimization**: Self-hosted fonts and icons.
1212

13-
## πŸ’» Commandes
13+
## Commands
1414

15-
| Commande | Action |
16-
| :------------- | :------------------------- |
17-
| `pnpm install` | Installe les dΓ©pendances |
18-
| `pnpm dev` | Lance le serveur de dev |
19-
| `pnpm lint` | VΓ©rifie la qualitΓ© du code |
20-
| `pnpm format` | Formate le projet |
21-
| `pnpm build` | Génère le site statique |
15+
| Command | Action |
16+
| :------------- | :---------------------------------- |
17+
| `pnpm install` | Install dependencies |
18+
| `pnpm dev` | Start development server |
19+
| `pnpm lint` | Check code quality |
20+
| `pnpm format` | Format the project |
21+
| `pnpm build` | Generate static site for production |
2222

23-
## πŸ“ Structure du Projet
23+
## Project Structure
2424

2525
```text
2626
src/
27-
β”œβ”€β”€ assets/ # Images optimisΓ©es
28-
β”œβ”€β”€ components/ # Composants Astro
29-
β”œβ”€β”€ content/ # DonnΓ©es JSON (projets, profil)
30-
β”œβ”€β”€ layouts/ # Layout et logique de thΓ¨me
27+
β”œβ”€β”€ assets/ # Optimized images
28+
β”œβ”€β”€ components/ # Astro components
29+
β”œβ”€β”€ content/ # JSON data (projects, profile)
30+
β”œβ”€β”€ layouts/ # Layout and theme logic
3131
β”œβ”€β”€ pages/ # Routes
3232
└── styles/ # Design tokens
3333
```
3434

35+
## Content Management
36+
37+
The site is data-driven. To update content:
38+
39+
- **Projects**: Edit or add JSON files in `src/content/projects/`.
40+
- **Profile**: Edit `src/content/user/profile.json`.
41+
- **Images**: Place project images in `src/assets/projects/` and reference them in JSON files (e.g., `../../assets/projects/image.webp`).
42+
- **Icons**: Add new technology icons to `public/icons/` if missing.
43+
3544
---
3645

37-
Fait avec ❀️ par [Nicolas Genty](https://github.com/nicgen)
46+
Built by [Nicolas Genty](https://github.com/nicgen)

0 commit comments

Comments
Β (0)