From d9b7f641d7a3a638d7cdab52c18b3464bb294a32 Mon Sep 17 00:00:00 2001 From: Olivier Date: Sun, 24 May 2026 08:56:40 +0200 Subject: [PATCH] Improve README documentation --- .gitignore | 1 + README.fr.md | 106 +++++++++++++++++++++++++++++++++++++++++++++ README.md | 118 +++++++++++++++++++++++++++++++++------------------ 3 files changed, 183 insertions(+), 42 deletions(-) create mode 100644 .gitignore create mode 100644 README.fr.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c317064 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +AGENTS.md diff --git a/README.fr.md b/README.fr.md new file mode 100644 index 0000000..941ecae --- /dev/null +++ b/README.fr.md @@ -0,0 +1,106 @@ +
+ +# Boîte à outils Windows logiciels libres + +Petite boîte à outils Windows pour installer des packs de logiciels libres avec `winget` et supprimer certaines applications intégrées à Windows. + +[![Windows](https://img.shields.io/badge/Windows-11%2024H2+-0078D4?style=for-the-badge&logo=windows&logoColor=white)](#prerequis) +[![winget](https://img.shields.io/badge/winget-configuration-0B6AB3?style=for-the-badge)](#packs-automatises) +[![PowerShell](https://img.shields.io/badge/PowerShell-scripts-5391FE?style=for-the-badge&logo=powershell&logoColor=white)](#installateur-interactif) +[![Licence](https://img.shields.io/badge/licence-GPL--3.0-or--later-2E8B57?style=for-the-badge)](./LICENSE) + +[English](./README.md) | **Français** + +
+ +--- + +## Contenu du dépôt + +| Chemin | Rôle | +| --- | --- | +| [`powershell/libres-softwares-install.ps1`](./powershell/libres-softwares-install.ps1) | Installateur interactif pour une liste de logiciels sélectionnés. | +| [`powershell/Winget-Remove-BuiltInApps.ps1`](./powershell/Winget-Remove-BuiltInApps.ps1) | Suppression de certaines applications Windows intégrées pour l'utilisateur courant. | +| [`winget/libre-soft-start-pack.yaml`](./winget/libre-soft-start-pack.yaml) | Pack automatisé de départ : Firefox ESR, 7-Zip et VLC. | +| [`winget/libre-soft-base-libreoffice.yaml`](./winget/libre-soft-base-libreoffice.yaml) | Pack de départ avec LibreOffice. | +| [`winget/libre-soft-base-onlyoffice.yaml`](./winget/libre-soft-base-onlyoffice.yaml) | Pack de départ avec ONLYOFFICE. | + + + +## Prérequis + +Lance les commandes depuis un **terminal administrateur** sous Windows. + +Active d'abord la prise en charge des configurations winget : + +```powershell +winget configure --enable +``` + +Les packs YAML automatisés déclarent actuellement un prérequis **Windows 11 24H2** ou plus récent. + +## Installateur Interactif + +Choisis les logiciels à installer depuis un menu PowerShell. + +![Capture de l'installateur interactif](./img/interactive.png) + +Commande à lancer depuis la racine du dépôt : + +```powershell +powershell -ExecutionPolicy Bypass -File .\powershell\libres-softwares-install.ps1 +``` + +Logiciels disponibles : + +| Logiciel | ID winget | +| --- | --- | +| Firefox ESR (FR) | `Mozilla.Firefox.ESR.fr` | +| 7-Zip | `7zip.7zip` | +| VLC Media Player | `VideoLAN.VLC` | +| ONLYOFFICE | `ONLYOFFICE.DesktopEditors` | +| LibreOffice | `TheDocumentFoundation.LibreOffice` | +| GIMP | `GIMP.GIMP.3` | +| Inkscape | `Inkscape.Inkscape` | +| Chromium | `Hibbiki.Chromium` | +| Bitwarden | `Bitwarden.Bitwarden` | +| Thunderbird | `Mozilla.Thunderbird` | + + + +## Packs Automatisés + +Utilise les fichiers de configuration winget pour obtenir une installation reproductible. + +| Pack | Contenu | Commande | +| --- | --- | --- | +| Pack de départ | Firefox ESR, 7-Zip, VLC | `winget configure --file .\winget\libre-soft-start-pack.yaml --accept-configuration-agreements` | +| Pack LibreOffice | Pack de départ, LibreOffice | `winget configure --file .\winget\libre-soft-base-libreoffice.yaml --accept-configuration-agreements` | +| Pack ONLYOFFICE | Pack de départ, ONLYOFFICE | `winget configure --file .\winget\libre-soft-base-onlyoffice.yaml --accept-configuration-agreements` | + +Exemple : + +```powershell +winget configure --file .\winget\libre-soft-start-pack.yaml --accept-configuration-agreements +``` + +## Supprimer des Applications Intégrées + +Le script de nettoyage désinstalle certaines applications Windows pour l'utilisateur courant. + +```powershell +powershell -ExecutionPolicy Bypass -File .\powershell\Winget-Remove-BuiltInApps.ps1 +``` + +Les applications visées incluent des composants Xbox, Outlook for Windows, Hub de commentaires, OneDrive, Teams, Microsoft To Do, des applications Bing, Clipchamp et des packages intégrés associés. + +## Note de Maintenance + +Lorsqu'un script, un ID de package, le contenu d'un pack ou une commande documentée change, mets à jour les deux fichiers README : + +- [`README.md`](./README.md) pour l'anglais. +- [`README.fr.md`](./README.fr.md) pour le français. + +## Licence + +Ce projet est distribué sous licence [GPL-3.0-or-later](./LICENSE). diff --git a/README.md b/README.md index 089fd7a..6d5909c 100644 --- a/README.md +++ b/README.md @@ -1,68 +1,102 @@ -# Windows +
-## Winget +# Windows libre software toolkit -### Requirements +Small Windows toolkit to install libre software packs with `winget` and remove selected built-in Windows apps. -Enable Winget in terminal as administrator : +[![Windows](https://img.shields.io/badge/Windows-11%2024H2+-0078D4?style=for-the-badge&logo=windows&logoColor=white)](#requirements) +[![winget](https://img.shields.io/badge/winget-configuration-0B6AB3?style=for-the-badge)](#automated-packs) +[![PowerShell](https://img.shields.io/badge/PowerShell-scripts-5391FE?style=for-the-badge&logo=powershell&logoColor=white)](#interactive-installer) +[![License](https://img.shields.io/badge/license-GPL--3.0-or--later-2E8B57?style=for-the-badge)](./LICENSE) -``` +**English** | [Français](./README.fr.md) + +
+ +--- + +## What is inside? + +| Path | Purpose | +| --- | --- | +| [`powershell/libres-softwares-install.ps1`](./powershell/libres-softwares-install.ps1) | Interactive installer for a curated list of applications. | +| [`powershell/Winget-Remove-BuiltInApps.ps1`](./powershell/Winget-Remove-BuiltInApps.ps1) | Removes selected built-in Windows applications for the current user. | +| [`winget/libre-soft-start-pack.yaml`](./winget/libre-soft-start-pack.yaml) | Automated starter pack: Firefox ESR, 7-Zip and VLC. | +| [`winget/libre-soft-base-libreoffice.yaml`](./winget/libre-soft-base-libreoffice.yaml) | Starter pack plus LibreOffice. | +| [`winget/libre-soft-base-onlyoffice.yaml`](./winget/libre-soft-base-onlyoffice.yaml) | Starter pack plus ONLYOFFICE. | + +## Requirements + +Run the commands from an **administrator terminal** on Windows. + +Enable winget configuration support first: + +```powershell winget configure --enable ``` -### Uninstalling Windows applications via winget +The automated YAML packs currently assert **Windows 11 24H2** or newer. -Uninstall Windows applications just for the current user. Run the PowerShell script `Winget-Remove-BuiltInApps.ps1` located in the powershell folder : +## Interactive Installer -``` -powershell -ExecutionPolicy Bypass -File .\Winget-Remove-BuiltInApps.ps1 +Choose the software you want to install from a PowerShell menu. + +![Interactive installer screenshot](./img/interactive.png) + +Run from the repository root: + +```powershell +powershell -ExecutionPolicy Bypass -File .\powershell\libres-softwares-install.ps1 ``` -### Installing libre softwares +Available applications: -#### Interactive +| Application | winget ID | +| --- | --- | +| Firefox ESR (FR) | `Mozilla.Firefox.ESR.fr` | +| 7-Zip | `7zip.7zip` | +| VLC Media Player | `VideoLAN.VLC` | +| ONLYOFFICE | `ONLYOFFICE.DesktopEditors` | +| LibreOffice | `TheDocumentFoundation.LibreOffice` | +| GIMP | `GIMP.GIMP.3` | +| Inkscape | `Inkscape.Inkscape` | +| Chromium | `Hibbiki.Chromium` | +| Bitwarden | `Bitwarden.Bitwarden` | +| Thunderbird | `Mozilla.Thunderbird` | -![interactive screenshot](./img/interactive.png) +## Automated Packs -Launch terminal as administrator and run the following command : +Use winget configuration files when you want a repeatable installation. -``` -powershell -ExecutionPolicy Bypass -File .\libres-softwares-install.ps1 +| Pack | Includes | Command | +| --- | --- | --- | +| Starter pack | Firefox ESR, 7-Zip, VLC | `winget configure --file .\winget\libre-soft-start-pack.yaml --accept-configuration-agreements` | +| LibreOffice pack | Starter pack, LibreOffice | `winget configure --file .\winget\libre-soft-base-libreoffice.yaml --accept-configuration-agreements` | +| ONLYOFFICE pack | Starter pack, ONLYOFFICE | `winget configure --file .\winget\libre-soft-base-onlyoffice.yaml --accept-configuration-agreements` | + +Example: + +```powershell +winget configure --file .\winget\libre-soft-start-pack.yaml --accept-configuration-agreements ``` -#### Automated +## Remove Built-In Apps -**Starter pack** : -* Firefox ESR (FR) -* 7Zip -* VLC +The cleanup script uninstalls selected Windows applications for the current user. -Launch terminal as administrator and run the following command : - -``` -winget configure --file libre-soft-start-pack.yaml --accept-configuration-agreements +```powershell +powershell -ExecutionPolicy Bypass -File .\powershell\Winget-Remove-BuiltInApps.ps1 ``` -**Starter pack + LibreOffice** : -* Firefox ESR (FR) -* 7Zip -* VLC -* LibreOffice +Targeted applications include Xbox components, Outlook for Windows, Feedback Hub, OneDrive, Teams, Microsoft To Do, Bing apps, Clipchamp and related built-in packages. -Launch terminal as administrator and run the following command : +## Maintenance Note -``` -winget configure --file .\libre-soft-base-libreoffice.yaml --accept-configuration-agreements -``` +When changing scripts, package IDs, pack contents or documented commands, update both README files: -**Starter pack + OnlyOffice** : -* Firefox ESR (FR) -* 7Zip -* VLC -* OnlyOffice +- [`README.md`](./README.md) for English. +- [`README.fr.md`](./README.fr.md) for French. -Launch terminal as administrator and run the following command : +## License -``` -winget configure --file .\libre-soft-base-onlyoffice.yaml --accept-configuration-agreements -``` +This project is distributed under the [GPL-3.0-or-later license](./LICENSE).