Captures d'écran

Interface principale avec sidebar de navigation, rendu Markdown et thème sombre.

Fonctionnalités

Raccourcis clavier

Installation

Télécharger une release

Rendez-vous sur la page Releases et téléchargez le fichier correspondant à votre système.

Windows

• Télécharge le fichier .exe (installeur NSIS) ou .msi

• Si Windows SmartScreen s'affiche : clic "Informations complémentaires" → "Exécuter quand même"

macOS

• Télécharge le fichier .dmg

• Si macOS bloque l'app : clic droit sur l'app → Ouvrir → Ouvrir quand même

Linux

• Télécharge le fichier .AppImage et rends-le exécutable :

  chmod +x ReadmeVault_*.AppImage
  ./ReadmeVault_*.AppImage
  

• Un .deb (Debian/Ubuntu) est également disponible.

Compiler depuis les sources

Prérequis

Dépendances Linux supplémentaires

sudo apt-get install -y \
  libwebkit2gtk-4.1-dev \
  libappindicator3-dev \
  librsvg2-dev \
  patchelf

Cloner et installer

git clone https://github.com/titithen00b/ReadmeVaultCross.git
cd ReadmeVaultCross
npm install

Lancer en mode développement

npm run tauri dev

Compiler pour la production

npm run tauri build

Les artefacts sont générés dans src-tauri/target/release/bundle/.

Architecture

ReadmeVaultCross/
├── src/                        # Frontend Svelte + TypeScript
│   ├── App.svelte              # Composant racine, layout, modales
│   ├── main.ts                 # Point d'entrée Vite
│   ├── app.css                 # Variables CSS globales (thème, couleurs)
│   └── lib/
│       ├── types.ts            # Types TypeScript (Project, SortMode…)
│       ├── store.ts            # État global Svelte (writable/derived)
│       ├── github.ts           # Appels API GitHub (README, infos repo)
│       ├── markdown.ts         # Rendu Markdown (marked + highlight.js)
│       └── components/
│           ├── Sidebar.svelte          # Liste projets, recherche, tri, tags
│           ├── ProjectDetail.svelte    # Affichage README (rendu/brut/infos)
│           ├── ProjectForm.svelte      # Formulaire création/édition
│           ├── ImportGitHub.svelte     # Import depuis une URL GitHub
│           ├── ImportBulkGitHub.svelte # Import en masse
│           ├── SettingsModal.svelte    # Paramètres (token GitHub, thème…)
│           ├── AboutModal.svelte       # À propos de l'application
│           └── HelpModal.svelte        # Aide et raccourcis clavier
│
├── src-tauri/                  # Backend Rust (Tauri)
│   ├── src/
│   │   ├── main.rs             # Point d'entrée Tauri
│   │   └── lib.rs              # Commandes IPC, menu natif, persistance
│   ├── icons/                  # Icônes app (PNG, ICNS…)
│   ├── capabilities/
│   │   └── default.json        # Permissions Tauri (fs, shell…)
│   └── tauri.conf.json         # Configuration Tauri (fenêtre, bundle…)
│
├── .github/
│   └── workflows/
│       └── build.yml           # CI/CD — builds macOS / Windows / Linux
│
├── index.html                  # Point d'entrée HTML
├── vite.config.ts              # Configuration Vite
├── svelte.config.js            # Configuration Svelte
├── tsconfig.json               # Configuration TypeScript
└── package.json

Stockage des données

Les données sont stockées localement via les commandes Rust save_projects / load_projects :

• projects.json — métadonnées de tous les projets (sans le contenu README)
• readmes/<id>.md — contenu README de chaque projet (fichier séparé)

Stack technique

CI/CD

Le workflow GitHub Actions (.github/workflows/build.yml) se déclenche :

• Sur chaque push de tag v* (ex: v1.0.0) → crée une release draft
• Sur déclenchement manuel (workflow_dispatch)

Plateformes compilées en parallèle :

• macos-latest → .dmg + .app
• windows-latest → .exe (NSIS) + .msi
• ubuntu-22.04 → .AppImage + .deb

Publier une release

git tag v1.0.0
git push origin v1.0.0

La release est créée en draft — vérifier les artefacts avant de la publier manuellement sur GitHub.

Contribuer

Les contributions sont les bienvenues !

1. Fork le repo
2. Crée une branche : git checkout -b feature/ma-fonctionnalite
3. Commit : git commit -m "feat: ajouter ma fonctionnalité"
4. Push : git push origin feature/ma-fonctionnalite
5. Ouvre une Pull Request

Signaler un bug

Ouvre une issue GitHub avec :

• OS et version
• Étapes pour reproduire
• Comportement attendu vs observé

Licence

MIT — © 2025 Valentin R. (Titithen00b)