Skip to content

Commit 0e6a6eb

Browse files
committed
docs(readme): Extract Windows guide into a dedicated WINDOWS.md
The Windows-specific section had grown into a long inline `[!WARNING]` block (Windows Terminal prerequisite, installation, usage, programmatic mode, install menu) that dwarfed the rest of the install section and hurt readability for Linux/Mac readers. Move it to a dedicated WINDOWS.md and replace it with a one-line pointer. Also split the "globally available" subsection so each OS has its own description instead of two side-by-side blocks.
1 parent 1b1430f commit 0e6a6eb

2 files changed

Lines changed: 56 additions & 53 deletions

File tree

‎README.md‎

Lines changed: 3 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -29,54 +29,11 @@ cd albert-code
2929

3030
Le lanceur crée automatiquement un environnement virtuel Python (`.venv/`), installe les dépendances et démarre Albert Code. Au premier lancement, la clé API est demandée.
3131

32-
Sous Windows, utiliser `albert-code.bat` à la place de `albert-code.sh`.
33-
34-
> [!WARNING]
35-
> **Sous Windows, Albert Code nécessite Windows Terminal pour afficher son interface.** L'invite de commande classique (`cmd.exe`) et la fenêtre PowerShell ouverte directement depuis le menu Démarrer ne savent pas afficher la TUI Textual ; l'application semble alors figée.
36-
>
37-
> ### Installation de Windows Terminal
38-
>
39-
> Windows Terminal est l'application de terminal moderne de Microsoft, gratuite. Sur Windows 11, elle est installée par défaut. Sur Windows 10, l'installation manuelle est nécessaire :
40-
>
41-
> 1. Ouvrir le **Microsoft Store** depuis le menu Démarrer.
42-
> 2. Rechercher **Windows Terminal**, ou ouvrir directement le lien https://aka.ms/terminal (qui redirige vers la page Store https://apps.microsoft.com/detail/9n0dx20hk701).
43-
> 3. Cliquer sur **Obtenir** ou **Installer**. L'opération prend quelques secondes.
44-
>
45-
> Pour les machines sans Microsoft Store, le `.msixbundle` de la dernière version est téléchargeable depuis la page des releases : https://github.com/microsoft/terminal/releases.
46-
>
47-
> ### Utilisation avec Albert Code
48-
>
49-
> 1. Ouvrir le menu Démarrer et taper **Terminal** (sous Windows, le programme est listé sous ce nom et non "Windows Terminal"). L'icône est noire et porte un chevron. Le lancer.
50-
> 2. Par défaut, Windows Terminal ouvre un onglet **PowerShell** : ce comportement est normal et tout à fait approprié. PowerShell est un shell parfaitement compatible avec Albert Code. Windows Terminal n'est qu'un *conteneur de terminal* ; le shell qu'il héberge importe peu (PowerShell, cmd, WSL, etc. fonctionnent tous).
51-
> 3. Se déplacer jusqu'au dossier d'Albert Code et lancer le `.bat` (le préfixe `.\` est requis sous PowerShell pour exécuter un script du dossier courant) :
52-
>
53-
> ```powershell
54-
> cd C:\chemin\vers\albert-code
55-
> .\albert-code.bat
56-
> ```
57-
>
58-
> Pour confirmer que la session s'exécute bien dans Windows Terminal, taper la commande suivante : `echo $env:WT_SESSION`. La variable doit afficher un identifiant. Si elle est vide, la session n'est pas dans Windows Terminal.
59-
>
60-
> ### Sans Windows Terminal
61-
>
62-
> Le mode programmatique `albert-code.bat -p "votre prompt"` n'utilise pas la TUI et fonctionne dans n'importe quelle console (cmd.exe, PowerShell standard). Il convient aux usages scriptés mais ne fournit pas l'interface interactive.
63-
>
64-
> ### Menu d'installation
65-
>
66-
> Lancer `.\albert-code.bat` sans argument affiche un menu interactif :
67-
>
68-
> 1. **Lancer Albert Code** : démarre l'application normalement.
69-
> 2. **Installer la commande dans le PATH utilisateur** : ajoute le dossier d'Albert Code au `PATH` afin que `albert-code` soit disponible depuis n'importe quel répertoire (équivalent CLI : `albert-code.bat --install`).
70-
> 3. **Désinstaller la commande du PATH utilisateur** : retire l'entrée du `PATH` (équivalent CLI : `albert-code.bat --uninstall`). Le dossier et l'application restent en place.
71-
> 4. **Quitter** : ferme le menu sans rien lancer.
72-
>
73-
> Avec des arguments (par exemple `albert-code.bat -p "..."` ou `albert-code.bat --version`), le menu est court-circuité et la commande s'exécute directement.
32+
Sous Windows, utiliser `albert-code.bat` à la place de `albert-code.sh`. Voir [WINDOWS.md](WINDOWS.md) pour les pré-requis (Windows Terminal) et les instructions détaillées.
7433

7534
### Rendre la commande disponible globalement (optionnel)
7635

77-
Pour pouvoir taper `albert-code` depuis n'importe quel dossier au lieu de `/chemin/vers/albert-code/albert-code.sh`, les deux lanceurs proposent une sous-commande d'installation. Le dossier de travail courant est préservé : Albert Code s'exécute toujours dans le répertoire d'où la commande est appelée.
78-
79-
**Linux / Mac** (crée un lien symbolique dans `~/.local/bin/`) :
36+
Pour pouvoir taper `albert-code` depuis n'importe quel dossier au lieu de `/chemin/vers/albert-code/albert-code.sh`, le lanceur propose une sous-commande d'installation qui crée un lien symbolique dans `~/.local/bin/`. Le dossier de travail courant est préservé : Albert Code s'exécute toujours dans le répertoire d'où la commande est appelée.
8037

8138
```bash
8239
./albert-code.sh --install # installe le lien
@@ -85,14 +42,7 @@ Pour pouvoir taper `albert-code` depuis n'importe quel dossier au lieu de `/chem
8542

8643
Si `~/.local/bin` n'est pas dans le `PATH`, le script l'indique et propose la ligne à ajouter au `~/.bashrc` ou `~/.zshrc`.
8744

88-
**Windows** (ajoute le dossier au `PATH` utilisateur) :
89-
90-
```powershell
91-
.\albert-code.bat --install # ajoute le dossier au PATH
92-
.\albert-code.bat --uninstall # retire le dossier du PATH
93-
```
94-
95-
Sous Windows, ces sous-commandes font la même chose que les options 2 et 3 du menu interactif. Ouvrir une nouvelle fenêtre Windows Terminal après l'installation pour que la modification du `PATH` soit prise en compte.
45+
Pour la procédure équivalente sous Windows (ajout au `PATH` utilisateur), voir [WINDOWS.md](WINDOWS.md).
9646

9747
## 3 - Utilisation
9848

‎WINDOWS.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Albert Code sous Windows
2+
3+
> [!WARNING]
4+
> **Sous Windows, Albert Code nécessite Windows Terminal pour afficher son interface.** L'invite de commande classique (`cmd.exe`) et la fenêtre PowerShell ouverte directement depuis le menu Démarrer ne savent pas afficher la TUI Textual ; l'application semble alors figée.
5+
6+
## Installation de Windows Terminal
7+
8+
Windows Terminal est l'application de terminal moderne de Microsoft, gratuite. Sur Windows 11, elle est installée par défaut. Sur Windows 10, l'installation manuelle est nécessaire :
9+
10+
1. Ouvrir le **Microsoft Store** depuis le menu Démarrer.
11+
2. Rechercher **Windows Terminal**, ou ouvrir directement le lien https://aka.ms/terminal (qui redirige vers la page Store https://apps.microsoft.com/detail/9n0dx20hk701).
12+
3. Cliquer sur **Obtenir** ou **Installer**. L'opération prend quelques secondes.
13+
14+
Pour les machines sans Microsoft Store, le `.msixbundle` de la dernière version est téléchargeable depuis la page des releases : https://github.com/microsoft/terminal/releases.
15+
16+
## Utilisation avec Albert Code
17+
18+
1. Ouvrir le menu Démarrer et taper **Terminal** (sous Windows, le programme est listé sous ce nom et non "Windows Terminal"). L'icône est noire et porte un chevron. Le lancer.
19+
2. Par défaut, Windows Terminal ouvre un onglet **PowerShell** : ce comportement est normal et tout à fait approprié. PowerShell est un shell parfaitement compatible avec Albert Code. Windows Terminal n'est qu'un *conteneur de terminal* ; le shell qu'il héberge importe peu (PowerShell, cmd, WSL, etc. fonctionnent tous).
20+
3. Se déplacer jusqu'au dossier d'Albert Code et lancer le `.bat` (le préfixe `.\` est requis sous PowerShell pour exécuter un script du dossier courant) :
21+
22+
```powershell
23+
cd C:\chemin\vers\albert-code
24+
.\albert-code.bat
25+
```
26+
27+
Pour confirmer que la session s'exécute bien dans Windows Terminal, taper la commande suivante : `echo $env:WT_SESSION`. La variable doit afficher un identifiant. Si elle est vide, la session n'est pas dans Windows Terminal.
28+
29+
## Sans Windows Terminal
30+
31+
Le mode programmatique `albert-code.bat -p "votre prompt"` n'utilise pas la TUI et fonctionne dans n'importe quelle console (cmd.exe, PowerShell standard). Il convient aux usages scriptés mais ne fournit pas l'interface interactive.
32+
33+
## Menu d'installation
34+
35+
Lancer `.\albert-code.bat` sans argument affiche un menu interactif :
36+
37+
1. **Lancer Albert Code** : démarre l'application normalement.
38+
2. **Installer la commande dans le PATH utilisateur** : ajoute le dossier d'Albert Code au `PATH` afin que `albert-code` soit disponible depuis n'importe quel répertoire (équivalent CLI : `albert-code.bat --install`).
39+
3. **Désinstaller la commande du PATH utilisateur** : retire l'entrée du `PATH` (équivalent CLI : `albert-code.bat --uninstall`). Le dossier et l'application restent en place.
40+
4. **Quitter** : ferme le menu sans rien lancer.
41+
42+
Avec des arguments (par exemple `albert-code.bat -p "..."` ou `albert-code.bat --version`), le menu est court-circuité et la commande s'exécute directement.
43+
44+
## Ajout au `PATH` utilisateur
45+
46+
Pour pouvoir taper `albert-code` depuis n'importe quel dossier, le lanceur Windows propose une sous-commande d'installation qui ajoute le dossier d'Albert Code au `PATH` utilisateur :
47+
48+
```powershell
49+
.\albert-code.bat --install # ajoute le dossier au PATH
50+
.\albert-code.bat --uninstall # retire le dossier du PATH
51+
```
52+
53+
Ces sous-commandes font la même chose que les options 2 et 3 du menu interactif. Ouvrir une nouvelle fenêtre Windows Terminal après l'installation pour que la modification du `PATH` soit prise en compte.

0 commit comments

Comments
 (0)