From 038e39307e4b6c31e276d9880030eebb1942c20f Mon Sep 17 00:00:00 2001 From: Hyko Date: Fri, 24 Apr 2026 09:14:59 -0400 Subject: [PATCH] docs(readme): update readme with theme description, installation and development instructions --- README.md | 41 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 40 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7b0f72d..a4e41ec 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,41 @@ -# octo-vscode +# Octo Theme +Thème VSCode épuré disponible en variante claire et sombre. + +## Variantes + +| Thème | Style | +|-------|-------| +| **Octo Dark** | Très sombre, reposant pour les longues sessions | +| **Octo Light** | Propre et lisible en pleine lumière, parfait pour développer durant la journée | + +Coloration sémantique activée sur les deux variantes. + +## Installation + +### Via le marketplace + +Recherche **Octo Theme** dans l'onglet Extensions de ton éditeur. + +### Via un fichier VSIX + +1. Télécharge le fichier `.vsix` depuis les [releases](https://git.hyko.cx/hykocx/octo-vscode/releases). +2. Ouvre la palette de commandes (`Ctrl+Shift+P` / `Cmd+Shift+P`). +3. Cherche **Extensions: Installer depuis un fichier VSIX...** et sélectionne le fichier téléchargé. + +## Appliquer le thème + +1. Ouvre la palette de commandes. +2. Cherche **Préférences : Thème de couleur**. +3. Sélectionne **Octo Dark** ou **Octo Light**. + +> **Astuce** : C'est encore mieux quand tu configures les deux ! Dans tes paramètres VSCode : +> 1. Définis **Octo Light** pour `workbench.preferredLightColorTheme` et **Octo Dark** pour `workbench.preferredDarkColorTheme`. +> 2. Active `window.autoDetectColorScheme` → VSCode suivra alors automatiquement ton thème système. + +## Développement + +```bash +npm install +npm run package # génère le .vsix +```