Skip to content

Commit f75f0ad

Browse files
author
Anaïs Saraiva
committed
Update README.md
1 parent 0ecfb9a commit f75f0ad

File tree

1 file changed

+98
-9
lines changed

1 file changed

+98
-9
lines changed

README.md

Lines changed: 98 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,105 @@
1-
# Tauri + Vue + TypeScript
1+
# Générateur de Couvertures Martine
22

3-
This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
3+
Créez vos propres couvertures parodiques des livres Martine avec vos textes personnalisés !
44

5-
## Recommended IDE Setup
5+
## C'est quoi ?
66

7-
- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
7+
Une petite application qui permet de faire des couvertures Martine rigolotes. Tu choisis une jaquette, tu modifies le texte, et hop ! Tu peux sauvegarder ton image.
88

9-
## Type Support For `.vue` Imports in TS
9+
## Comment ça marche ?
1010

11-
Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can enable Volar's Take Over mode by following these steps:
11+
1. Tu lances l'app
12+
2. Tu choisis une couverture Martine dans le slider
13+
3. Tu cliques sur le texte pour le modifier
14+
4. Tu cliques sur "Télécharger" pour sauvegarder
1215

13-
1. Run `Extensions: Show Built-in Extensions` from VS Code's command palette, look for `TypeScript and JavaScript Language Features`, then right click and select `Disable (Workspace)`. By default, Take Over mode will enable itself if the default TypeScript extension is disabled.
14-
2. Reload the VS Code window by running `Developer: Reload Window` from the command palette.
16+
## Installation
1517

16-
You can learn more about Take Over mode [here](https://github.com/johnsoncodehk/volar/discussions/471).
18+
### Ce dont tu as besoin
19+
- Node.js (version récente)
20+
- Rust (pour compiler l'app)
21+
22+
### Étapes
23+
```bash
24+
# Télécharger le projet
25+
git clone https://github.com/Kisakay/martine.git
26+
cd martine
27+
28+
# Installer les trucs
29+
npm install
30+
31+
# Lancer en test
32+
npm run tauri:dev
33+
34+
# Compiler pour de vrai
35+
npm run tauri:build
36+
```
37+
38+
## Ajouter des nouvelles jaquettes
39+
40+
1. **Mets ton image** dans le dossier `src-tauri/resources/covers/`
41+
- Nom du fichier : `9780000000001.jpg` (le numéro ISBN)
42+
43+
2. **Modifie le fichier** `src-tauri/resources/config.json` :
44+
```json
45+
{
46+
"covers": [
47+
{
48+
"id": 0,
49+
"title": "Martine fait du code",
50+
"isbn": 123456789,
51+
"color": "#FF0000",
52+
"width": 559,
53+
"height": 682,
54+
"context": {
55+
"v": "Martine découvre JavaScript",
56+
"x": 0,
57+
"y": 160,
58+
"w": 559,
59+
"a": "center"
60+
}
61+
}
62+
]
63+
}
64+
```
65+
66+
## Les réglages
67+
68+
- `title` : Le vrai titre du livre
69+
- `isbn` : Le numéro pour le nom du fichier image
70+
- `color` : La couleur du texte (format #FF0000)
71+
- `context.v` : Le texte qui s'affiche par défaut
72+
- `context.x/y` : Où placer le texte
73+
- `context.w` : La largeur de la zone de texte
74+
- `context.a` : L'alignement (`left`, `center`, `right`)
75+
76+
## Problèmes courants
77+
78+
**L'image ne s'affiche pas** : Vérifie que le nom du fichier correspond au numéro ISBN
79+
80+
**Ça plante au démarrage** : Assure-toi d'avoir installé Rust et les dépendances npm
81+
82+
**La sauvegarde marche pas** : Regarde dans les paramètres Tauri, il faut peut-être autoriser l'accès aux fichiers
83+
84+
## Fait avec
85+
86+
- Tauri (pour faire une app desktop)
87+
- Vue 3 (pour l'interface)
88+
- TypeScript (JavaScript mais en mieux)
89+
- Fabric.js (pour dessiner sur le canvas)
90+
91+
## Contribution
92+
93+
Tu veux ajouter des trucs ? Parfait !
94+
1. Fork le projet
95+
2. Fais tes modifs
96+
3. Envoie une pull request
97+
98+
## Licence
99+
100+
Libre d'utilisation. Les images Martine appartiennent à Casterman évidemment.
101+
102+
## Note légale
103+
104+
Ce projet est fait pour rigoler et apprendre. Les vraies couvertures Martine appartiennent à leurs créateurs.
105+
Je me suis inspiré de https://jesuismartine.com

0 commit comments

Comments
 (0)