diff --git a/README.md b/README.md index d667b10..5755ced 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Paycheck +# 🐷 Paycheck Paycheck est une application desktop permettant de calculer, vérifier et exporter la rémunération des astreintes à partir des données de paie (Excel), selon des profils de règles configurables. @@ -6,43 +6,43 @@ Give me my fuc** money. --- -## Fonctionnalités +## ✨ Fonctionnalités -- Import de fichiers Excel (.xlsx) -- Sélection d’un agent (nom, prénom, matricule) -- Calcul automatique des montants d’astreintes selon un profil -- Détail clair des lignes de rémunération -- Export PDF professionnel avec branding Paycheck -- Application desktop multiplateforme (Windows / Linux) +- 📥 Import de fichiers Excel (.xlsx) +- 👤 Sélection d’un agent (nom, prénom, matricule) +- 🧮 Calcul automatique des montants d’astreintes selon un profil +- 🧾 Détail clair des lignes de rémunération +- 📄 Export PDF professionnel avec branding Paycheck +- 🖥️ Application desktop multiplateforme (Windows / Linux) --- -## Stack technique +## 🧱 Stack technique -- Go (backend et logique métier) -- Wails v2 (application desktop) -- JavaScript / HTML / CSS (frontend) -- gofpdf (génération PDF) -- Vite (build frontend) +- 🧠 Go (backend et logique métier) +- 🪟 Wails v2 (application desktop) +- 🎨 JavaScript / HTML / CSS (frontend) +- 📄 gofpdf (génération PDF) +- ⚡ Vite (build frontend) --- -## Utilisation +## 🚀 Utilisation -### Utiliser le binaire +### ▶️ Utiliser le binaire Télécharger le binaire correspondant à votre système depuis la page Releases du dépôt. -- Windows : paycheck.exe -- Linux : paycheck +- 🪟 Windows : paycheck.exe +- 🐧 Linux : paycheck Aucune installation supplémentaire n’est nécessaire. --- -## Développement +## 🛠️ Développement -### Prérequis +### 🔧 Prérequis - Go 1.21 ou plus récent - Node.js 18 ou plus récent @@ -52,19 +52,19 @@ Vérification de l’environnement : wails doctor -### Lancer en mode développement +### ▶️ Lancer en mode développement wails dev --- -## Build de l’application +## 🏗️ Build de l’application -### Linux +### 🐧 Linux wails build -### Windows +### 🪟 Windows wails build -platform windows/amd64 @@ -74,24 +74,24 @@ build/bin/ --- -## Export PDF +## 📄 Export PDF L’export PDF inclut : -- Titre de l'application -- Mois de paie -- Identité de l’agent -- Profil appliqué -- Détail ligne par ligne des montants -- Total brut -- Légende des codes de paie -- Pied de page avec date d’export +- 🏷️ Titre et branding Paycheck +- 📅 Mois de paie +- 🧑 Identité de l’agent +- 📐 Profil appliqué +- 📋 Détail ligne par ligne des montants +- 💰 Total brut +- 🧾 Légende des codes de paie +- 🕒 Pied de page avec date d’export Le PDF est volontairement monopage, stable et prêt à être transmis. --- -## Structure du projet +## 📁 Structure du projet paycheck/ - main.go @@ -109,11 +109,11 @@ paycheck/ --- -## Versioning +## 🧭 Versioning Ce projet suit le Semantic Versioning. -- v1.0.0 : première version stable +- 🏁 v1.0.0 : première version stable - vX.Y.Z - X : changement majeur - Y : nouvelle fonctionnalité @@ -121,7 +121,7 @@ Ce projet suit le Semantic Versioning. --- -## Auteur +## 👨‍💻 Auteur **Alban Dumerain** pour Flooze Corp - *A Niaremud Nablax Company*. @@ -129,14 +129,14 @@ Développé avec amour ❤️ en Go. --- -## Licence +## 📜 Licence Projet distribué tel quel. Voir le fichier LICENSE si applicable. --- -## Historique +## 🕰️ Historique Paycheck est la version renommée et stabilisée du projet initialement appelé calcul-astreintes. -À partir de la version 1.0, seul Paycheck est maintenu. +À partir de la version 1.0, seul Paycheck est maintenu. \ No newline at end of file