refactor: automatisation de l'install (GRUB, deps, multi-distro) et nouvelle doc

2026-01-12 17:41:17 +01:00
parent 8e3251ed7f
commit b5859edc45
2 changed files with 191 additions and 115 deletions
--- a/README.md
+++ b/README.md
@@ -1,44 +1,79 @@
+Voici le contenu complet structuré pour votre fichier **README.md**. Vous pouvez copier ce bloc de texte et le coller directement dans un nouveau fichier.
+
+```markdown
 # Thème InnotexBootloarder pour Plymouth

-Ce projet est une version personnalisée du thème Plymouth, utilisant le logo Innotex et des messages de confidentialité.
-Il est basé sur [plymouth-bgrt](https://github.com/glics/plymouth-modern-bgrt).
-J’ai récupéré et adapté ce projet pour mon usage personnel.
+Ce projet propose un thème Plymouth personnalisé utilisant le logo **Innotex**. Il est conçu pour offrir une expérience de démarrage fluide et élégante, assurant la transition entre le logo du constructeur (BGRT) et le système d'exploitation.
+
+Ce projet est basé sur [plymouth-modern-bgrt](https://github.com/glics/plymouth-modern-bgrt) et a été amélioré pour inclure un script d'installation universel et automatisé.

 ![Aperçu](./preview.png)

 ---

-## Installation
+## 🚀 Fonctionnalités du script d'installation

-### Prérequis
- Un système Linux avec Plymouth installé.
- Les outils `imagemagick` (pour `convert`), `coreutils` (pour `install`) et `awk` doivent être présents.
- Une image de thème nommée `InnotexBootloarder.png` dans le dossier `InnotexBootloarder/`.
+Le script `install.sh` automatise désormais l'intégralité de la configuration :

-### Étapes d’installation
-
-1. Ouvrez un terminal dans le dossier du projet.
-2. Rendez le script d’installation exécutable :
-   ```sh
-   chmod +x install.sh
-   ```
-3. Lancez l’installation en tant que root :
-   ```sh
-   sudo ./install.sh
-   ```
-4. Activez le thème par défaut :
-   ```sh
-   sudo plymouth-set-default-theme -R InnotexBootloarder
-   ```
-
-## Licence
-
-Tous les fichiers de ce projet sont distribués sous [licence GNU GPL v3](./LICENSE).
+* **Multi-Distribution** : Supporte `apt` (Debian/Ubuntu), `dnf` (Fedora) et `pacman` (Arch Linux).
+* **Gestion des dépendances** : Installe automatiquement `plymouth`, `imagemagick` et `gawk` si nécessaire.
+* **Configuration GRUB** : Injecte automatiquement les paramètres `quiet splash` dans `/etc/default/grub` et met à jour le chargeur de démarrage.
+* **Intégration Système** : Installe les hooks d'initramfs et les fonctions LSB pour une meilleure compatibilité.
+* **Auto-Activation** : Définit le thème par défaut et régénère l'image `initramfs` en une seule étape.

 ---

-## Auteur du projet original `plymouth-bgrt`
+## 🛠 Installation

-Innotex
+### 1. Prérequis
+- Un système Linux avec **GRUB** comme chargeur de démarrage.
+- Les sources du thème situées dans le dossier `InnotexBootloarder/`.
+
+### 2. Exécution
+Ouvrez un terminal dans le dossier du projet et lancez les commandes suivantes :
+
+```bash
+# Rendre le script exécutable
+chmod +x install.sh
+
+# Lancer l'installation automatisée (nécessite les privilèges root)
+sudo ./install.sh
+
+```

 ---
+
+## 📂 Structure du projet
+
+* **InnotexBootloarder/** : Contient les images (.png), le fichier `.plymouth` et le template du script (`.script.in`).
+* **scripts/** : Contient les hooks pour l'initramfs et les fonctions de support.
+* **install.sh** : Le script principal d'installation et de configuration.
+* **preview.png** : Aperçu visuel du thème.
+
+---
+
+## 📝 Personnalisation
+
+Si vous souhaitez ajuster la position du logo par rapport au logo BGRT du BIOS, vous pouvez modifier les variables suivantes au début du script `install.sh` avant de lancer l'installation :
+
+* `BGRTLEFT` : Position horizontale (par défaut `0`).
+* `BGRTTOP` : Position verticale (par défaut `100`).
+
+---
+
+## ⚖️ Licence
+
+Ce projet est distribué sous la licence [GNU GPL v3](https://www.google.com/search?q=./LICENSE).
+
+---
+
+## Crédits
+
+* **Auteur original (`plymouth-bgrt`)** : [glics](https://github.com/glics/plymouth-modern-bgrt)
+* **Adaptation et automatisation** : Innotex
+
+```
+
+Souhaitez-vous que je vous prépare également le contenu du fichier **LICENSE** (GPL v3) ou que je vous aide à faire le **commit** et le **push** vers votre instance Gitea ?
+
+```