docs: update README for v0.3.7 with new features and Linux support
Reflect all changes since v0.2.3: Linux installation (deb/rpm/AppImage), multiple profiles, transaction splits, budgets, encrypted export/import, dark mode, interactive charts, user guide, and auto-updater. Fix GitHub repo URL in badges. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
parent
d1fa8e0200
commit
82d4739b96
1 changed files with 60 additions and 22 deletions
82
README.md
82
README.md
|
|
@ -1,31 +1,56 @@
|
||||||
# Simpl'Résultat
|
# Simpl'Résultat
|
||||||
|
|
||||||
Application de bureau pour importer, catégoriser et analyser les transactions financières de votre entreprise.
|
Application de bureau 100 % locale pour importer, catégoriser et analyser vos transactions financières personnelles ou d'entreprise. Aucune donnée ne quitte votre ordinateur.
|
||||||
|
|
||||||

|

|
||||||

|

|
||||||
|

|
||||||
|
|
||||||
## Fonctionnalités
|
## Fonctionnalités
|
||||||
|
|
||||||
- **Import CSV** — Importez vos relevés bancaires depuis plusieurs sources (Desjardins, etc.)
|
- **Import CSV** — Importez vos relevés bancaires depuis plusieurs sources avec auto-détection des colonnes et modèles d'import réutilisables
|
||||||
- **Tableau de bord** — Vue d'ensemble avec KPIs, répartition par catégorie et dernières dépenses
|
- **Tableau de bord** — Vue d'ensemble avec KPIs, répartition par catégorie et dernières transactions
|
||||||
- **Transactions** — Parcourez, recherchez et filtrez toutes vos transactions
|
- **Transactions** — Parcourez, recherchez et filtrez avec sélection rapide de période
|
||||||
- **Catégorisation automatique** — Attribution automatique par mots-clés, avec ajustement manuel
|
- **Catégorisation automatique** — Attribution automatique par mots-clés, avec ajustement manuel
|
||||||
- **Rapports** — Tendances mensuelles, répartition par catégorie, évolution dans le temps
|
- **Split de transactions** — Répartissez une transaction sur plusieurs catégories
|
||||||
|
- **Budgets** — Grille budgétaire 12 mois par catégorie avec modèles et rapport Budget vs Réel
|
||||||
|
- **Ajustements** — Ajustements ponctuels ou récurrents par catégorie
|
||||||
|
- **Rapports** — Tendances mensuelles, répartition par catégorie, évolution dans le temps, budget vs réel
|
||||||
|
- **Graphiques interactifs** — Motifs SVG, menu contextuel (clic droit), détail des transactions par catégorie
|
||||||
|
- **Profils multiples** — Bases de données séparées avec protection PIN optionnelle
|
||||||
|
- **Export / Import de données** — Sauvegarde complète avec chiffrement AES-256-GCM optionnel
|
||||||
|
- **Mode sombre** — Thème sombre avec palette gris chaud
|
||||||
- **Bilingue** — Interface disponible en français et en anglais
|
- **Bilingue** — Interface disponible en français et en anglais
|
||||||
|
- **Guide utilisateur intégré** — Documentation complète accessible depuis les paramètres, imprimable en PDF
|
||||||
|
- **Mise à jour automatique** — Notifications et installation des nouvelles versions depuis l'application
|
||||||
|
|
||||||
## Installation (Windows)
|
## Installation
|
||||||
|
|
||||||
1. Rendez-vous sur la page [**Releases**](../../releases/latest)
|
### Windows
|
||||||
2. Téléchargez le fichier `.msi` (installateur Windows)
|
|
||||||
|
1. Rendez-vous sur la page [**Releases**](https://github.com/Le-King-Fu/simpl-resultat/releases/latest)
|
||||||
|
2. Téléchargez le fichier `.exe` (installateur NSIS)
|
||||||
3. Lancez le fichier téléchargé
|
3. Lancez le fichier téléchargé
|
||||||
|
|
||||||
> **Note :** Windows SmartScreen peut afficher un avertissement car l'application n'est pas signée numériquement.
|
> **Note :** Windows SmartScreen peut afficher un avertissement car l'application n'est pas signée numériquement.
|
||||||
> Cliquez sur **« Informations complémentaires »** puis **« Exécuter quand même »** pour continuer.
|
> Cliquez sur **« Informations complémentaires »** puis **« Exécuter quand même »** pour continuer.
|
||||||
|
|
||||||
|
### Linux
|
||||||
|
|
||||||
|
1. Rendez-vous sur la page [**Releases**](https://github.com/Le-King-Fu/simpl-resultat/releases/latest)
|
||||||
|
2. Téléchargez le format adapté à votre distribution :
|
||||||
|
- `.deb` pour Debian / Ubuntu
|
||||||
|
- `.rpm` pour Fedora / openSUSE
|
||||||
|
- `.AppImage` pour toute distribution (exécutable universel)
|
||||||
|
3. Installez le paquet ou lancez l'AppImage directement
|
||||||
|
|
||||||
## Démarrage rapide
|
## Démarrage rapide
|
||||||
|
|
||||||
### 1. Configurer le dossier d'import
|
### 1. Choisir ou créer un profil
|
||||||
|
|
||||||
|
Au premier lancement, un profil par défaut est créé. Vous pouvez ajouter d'autres profils (chacun avec sa propre base de données) et les protéger par un PIN.
|
||||||
|
|
||||||
|
### 2. Configurer le dossier d'import
|
||||||
|
|
||||||
Organisez vos fichiers CSV dans un dossier avec un sous-dossier par source :
|
Organisez vos fichiers CSV dans un dossier avec un sous-dossier par source :
|
||||||
|
|
||||||
|
|
@ -39,31 +64,43 @@ Documents/
|
||||||
export.csv
|
export.csv
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2. Importer des transactions
|
### 3. Importer des transactions
|
||||||
|
|
||||||
- Allez dans **Transactions → Importer**
|
- Allez dans **Import**
|
||||||
- Sélectionnez le dossier source et les fichiers CSV
|
- Sélectionnez le dossier source et les fichiers CSV
|
||||||
- Configurez le mappage des colonnes (date, description, montant)
|
- Configurez le mappage des colonnes (ou utilisez un modèle d'import sauvegardé)
|
||||||
- Vérifiez l'aperçu puis lancez l'import
|
- Vérifiez les doublons puis lancez l'import
|
||||||
|
|
||||||
### 3. Consulter le tableau de bord
|
### 4. Consulter le tableau de bord
|
||||||
|
|
||||||
Le tableau de bord affiche automatiquement :
|
Le tableau de bord affiche automatiquement :
|
||||||
- Les KPIs du mois (revenus, dépenses, solde)
|
- Les KPIs du mois (revenus, dépenses, solde)
|
||||||
- La répartition des dépenses par catégorie
|
- La répartition des dépenses par catégorie
|
||||||
- Les dernières transactions
|
- Les dernières transactions
|
||||||
|
|
||||||
### 4. Parcourir et catégoriser les transactions
|
### 5. Parcourir et catégoriser les transactions
|
||||||
|
|
||||||
- Utilisez la recherche et les filtres (date, catégorie, source)
|
- Utilisez la recherche et les filtres (date, catégorie, source, période rapide)
|
||||||
- Modifiez la catégorie d'une transaction en cliquant dessus
|
- Modifiez la catégorie d'une transaction en cliquant dessus
|
||||||
- Ajoutez des mots-clés pour automatiser les futures catégorisations
|
- Ajoutez des mots-clés pour automatiser les futures catégorisations
|
||||||
|
- Scindez une transaction sur plusieurs catégories si nécessaire
|
||||||
|
|
||||||
### 5. Analyser les rapports
|
### 6. Gérer les budgets
|
||||||
|
|
||||||
|
- Définissez un budget mensuel par catégorie sur une grille 12 mois
|
||||||
|
- Créez des modèles budgétaires réutilisables
|
||||||
|
- Consultez le rapport **Budget vs Réel** pour suivre vos écarts
|
||||||
|
|
||||||
|
### 7. Analyser les rapports
|
||||||
|
|
||||||
- **Tendances** — Évolution mensuelle des revenus et dépenses
|
- **Tendances** — Évolution mensuelle des revenus et dépenses
|
||||||
- **Catégories** — Répartition détaillée par catégorie
|
- **Catégories** — Répartition détaillée par catégorie (clic droit pour masquer ou voir le détail)
|
||||||
- **Évolution** — Suivi dans le temps par catégorie
|
- **Évolution** — Suivi dans le temps par catégorie
|
||||||
|
- **Budget vs Réel** — Comparaison mensuelle et cumul annuel
|
||||||
|
|
||||||
|
### 8. Guide utilisateur
|
||||||
|
|
||||||
|
Un guide complet est accessible via **Paramètres → Guide utilisateur**. Il couvre toutes les fonctionnalités et peut être imprimé ou exporté en PDF.
|
||||||
|
|
||||||
## Développement
|
## Développement
|
||||||
|
|
||||||
|
|
@ -95,11 +132,11 @@ Les installateurs sont générés dans `src-tauri/target/release/bundle/`.
|
||||||
3. Créez et poussez un tag :
|
3. Créez et poussez un tag :
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git tag v0.1.0
|
git tag v0.3.7
|
||||||
git push origin v0.1.0
|
git push origin v0.3.7
|
||||||
```
|
```
|
||||||
|
|
||||||
Le workflow GitHub Actions compile automatiquement l'application et publie les installateurs dans une nouvelle Release.
|
Le workflow GitHub Actions compile automatiquement l'application pour Windows et Linux, puis publie les installateurs dans une nouvelle Release.
|
||||||
|
|
||||||
## Technologies
|
## Technologies
|
||||||
|
|
||||||
|
|
@ -111,3 +148,4 @@ Le workflow GitHub Actions compile automatiquement l'application et publie les i
|
||||||
| [Tailwind CSS v4](https://tailwindcss.com/) | Styles |
|
| [Tailwind CSS v4](https://tailwindcss.com/) | Styles |
|
||||||
| [Recharts](https://recharts.org/) | Graphiques |
|
| [Recharts](https://recharts.org/) | Graphiques |
|
||||||
| [react-i18next](https://react.i18next.com/) | Internationalisation |
|
| [react-i18next](https://react.i18next.com/) | Internationalisation |
|
||||||
|
| [PapaParse](https://www.papaparse.com/) | Parsing CSV |
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue