Improve README documentation
This commit is contained in:
@@ -1,68 +1,102 @@
|
||||
# Windows
|
||||
<div align="center">
|
||||
|
||||
## 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 :
|
||||
[](#requirements)
|
||||
[](#automated-packs)
|
||||
[](#interactive-installer)
|
||||
[](./LICENSE)
|
||||
|
||||
```
|
||||
**English** | [Français](./README.fr.md)
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## 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.
|
||||
|
||||
|
||||
|
||||
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` |
|
||||
|
||||
|
||||
## 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).
|
||||
|
||||
Reference in New Issue
Block a user