Dotfiles_ArchAP/README.md

142 lines
5.2 KiB
Markdown

<p align="center">
<img src="docs/assets/banner.png" alt="ArchASP Dotfiles — Reproducible Arch Linux user environment" width="100%">
</p>
<h1 align="center">ArchASP Dotfiles</h1>
<p align="center">
Environnement utilisateur Arch Linux reproductible, composé avec GNU Stow.
</p>
<p align="center">
<img alt="Arch Linux" src="https://img.shields.io/badge/Arch_Linux-user_environment-1793d1?style=flat-square&logo=archlinux&logoColor=white">
<img alt="Wayland avec SwayFX" src="https://img.shields.io/badge/Wayland-SwayFX-89b4fa?style=flat-square">
<img alt="GNU Stow" src="https://img.shields.io/badge/deployment-GNU_Stow-cba6f7?style=flat-square">
<img alt="Stable 0.1.0" src="https://img.shields.io/badge/stable-0.1.0-a6e3a1?style=flat-square">
</p>
<p align="center">
<a href="#-overview">Overview</a> ·
<a href="#-stack">Stack</a> ·
<a href="#-preview">Preview</a> ·
<a href="#-quick-start">Quick Start</a> ·
<a href="#-documentation">Documentation</a> ·
<a href="#-version">Version</a>
</p>
## ✦ Overview
`Dotfiles_ArchAP` décrit la couche **utilisateur** d'ArchASP : session Wayland,
shell, applications terminal, scripts personnels et unités systemd user. Chaque
package reproduit son chemin sous `$HOME` et GNU Stow déploie les liens
symboliques correspondants.
L'administration système reste séparée dans
[`arch-system`](https://git.labfytools.com/fy59/arch-system) : installation
Arch, boot, stockage, réseau, paquets, `/etc` et helpers root. Les inventaires
de ce dépôt documentent la machine réelle, mais ne constituent pas un
installateur automatique.
## ✦ Stack
| Desktop | Shell |
| --- | --- |
| `greetd → tuigreet → UWSM → SwayFX` | `Zsh → Starship → Atuin` |
| `QuickShell → barre et notifications` | `FZF → Zoxide → Eza → Bat → Yazi` |
| Wofi · Swaylock · Cliphist · Kitty | plugins Zsh et Tmux épinglés par sous-modules |
```mermaid
flowchart LR
G[greetd] --> T[tuigreet] --> U[UWSM] --> S[SwayFX]
S --> B[QuickShell : barre et notifications]
S --> W[Wofi]
S --> L[Swaylock]
S --> C[Cliphist]
S --> K[Kitty]
```
Les responsabilités et dépendances sont détaillées dans
[`docs/desktop.md`](docs/desktop.md) et [`docs/shell.md`](docs/shell.md).
## ✦ Preview
<p align="center">
<img src="docs/assets/screenshots/archasp.png" alt="Capture historique de l'environnement ArchASP sous Sway" width="100%">
</p>
<p align="center"><sub>Capture historique avant la migration SwayFX et QuickShell.</sub></p>
## ✦ Repository
```text
ArchASP
├── arch-system système/root · /etc · services système · installation
└── Dotfiles_ArchAP utilisateur · $HOME · Stow · systemd --user
```
Les 31 packages Stow couvrent le desktop, le shell, le développement, les
services utilisateur et l'apparence. `.assets/` contient les inventaires de
reconstruction ; `docs/` contient la documentation et n'est jamais un package
Stow. Voir le [contrat d'architecture](docs/architecture.md).
## ✦ Quick Start
Le chemin heureux utilise Bash pour le tableau des packages :
```bash
git clone --recurse-submodules \
ssh://git@git.labfytools.com:2223/fy59/Dotfiles_ArchAP.git \
"$HOME/.dotfiles"
cd "$HOME/.dotfiles"
packages=(atuin bat bin btop cliphist eza fastfetch fzf gtk-3.0 gtklock \
hyprwhspr icons kitty mako nvim opencode qt5ct qt6ct \
quickshell starship sway swaylock systemd themes tmux uwsm wallpapers wofi yazi \
ytmusic-tui zsh)
stow --no --verbose=2 --target="$HOME" "${packages[@]}"
stow --verbose=2 --target="$HOME" "${packages[@]}"
```
Le dry-run doit être examiné avant le déploiement. Les prérequis, conflits,
inventaires et validations sont décrits dans le
[guide d'installation](docs/installation.md).
## ✦ Documentation
| Guide | Sujet |
| --- | --- |
| [Documentation](docs/README.md) | Index et responsabilités des documents |
| [Architecture](docs/architecture.md) | Frontières ArchASP, Stow et données locales |
| [Installation](docs/installation.md) | Clone neuf, sous-modules, Stow et validations |
| [Desktop](docs/desktop.md) | Chaîne greetd/UWSM/Sway et composants Wayland |
| [Shell](docs/shell.md) | Zsh, outils interactifs, plugins et scripts |
| [systemd](docs/systemd.md) | Services système et unités utilisateur |
| [Packages](docs/packages.md) | Inventaires Pacman, AUR, services et outils externes |
| [Recovery](docs/recovery.md) | Reconstruction complète après perte du disque |
| [Security](docs/security.md) | Secrets exclus et règles de publication |
## ✦ Mirrors
| Rôle | Dépôt |
| --- | --- |
| Upstream principal | [Forgejo](https://git.labfytools.com/fy59/Dotfiles_ArchAP) |
| Miroir public | [GitHub](https://github.com/labfytools/Dotfiles_ArchAP) |
Le fetch d'`origin` reste attaché à Forgejo. Ses deux URLs de push publient
vers Forgejo et GitHub.
## ✦ Version
| Branche | Rôle |
| --- | --- |
| `0.1.0` | Snapshot stable de la première version nettoyée et documentée |
| `main` | Développement courant |
La branche stable est immobile : les développements suivants avancent sur
`main` sans déplacer automatiquement `0.1.0`.
## ✦ License
Aucune licence n'est actuellement déclarée pour ce dépôt. En l'absence de
licence, aucun droit de réutilisation n'est accordé implicitement.