From 4ff757fd0687a4a8cfc95c4305601326d23d25ef Mon Sep 17 00:00:00 2001 From: Charles Date: Fri, 26 Jun 2026 03:19:33 +0200 Subject: [PATCH] Ajout de la documentation utilisateur (README.md) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Description détaillée : Documentation d'utilisation destinée aux clients non-techniques. Contenu : - Disclaimer indépendance Distech Controls - Prérequis (Windows 10/11, PowerShell 5.1 inclus) - Guide de premier lancement : déblocage fichier, ExecutionPolicy, exécution - Guide d'utilisation : sélection script, types de champs, panneau README, bouton Lancer - Mise à jour automatique et mode hors ligne - Tableau des erreurs fréquentes avec solutions - Structure des fichiers du projet --- README.md | 186 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 186 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..3dfd14e --- /dev/null +++ b/README.md @@ -0,0 +1,186 @@ +# cadMasterCLI + +Outil de lancement simplifié de scripts PowerShell pour les automates Distech Controls Eclypse. + +--- + +> **IMPORTANT : Ce projet est un développement personnel indépendant.** +> +> Ce projet a été développé par Charles-Arthur DAVID à titre personnel. +> Distech Controls n'est pas responsable de ce projet et ne le supporte pas. +> Aucune demande de support ne sera prise en charge par Distech Controls. +> Distech Controls ne fournit aucune garantie ni assistance technique pour ce projet. + +--- + +## À quoi ça sert ? + +cadMasterCLI est une interface graphique qui vous permet de **lancer des scripts d'automatisation** sans savoir utiliser le terminal, sans connaître PowerShell, et sans configuration technique. + +Il suffit de : +1. Faire un clique-droit sur le fichier cadMasterCLI.ps1 et choisir "Exécuter avec Powershell" +2. Sélectionner le script que vous souhaitez exécuter +3. Remplir les informations demandées (adresse IP, fichier CSV, etc.) +4. Cliquer sur **Lancer le script** + +Les scripts sont téléchargés automatiquement depuis un serveur centralisé (Gitea). Si vous n'avez pas accès au réseau, les scripts déjà utilisés restent disponibles en mode hors ligne. + +--- + +## Prérequis + +| Élément | Détail | +|---|---| +| Système d'exploitation | Windows 10 ou Windows 11 | +| PowerShell | Version 5.1 — **déjà inclus dans Windows 10/11, rien à installer** | +| Accès réseau | Nécessaire pour télécharger les scripts (hors ligne possible si déjà téléchargés) | + +Aucun autre logiciel n'est nécessaire. + +--- + +## Installation + +Aucune installation requise. cadMasterCLI est un seul fichier `.ps1`. + +1. Téléchargez le fichier `cadMasterCLI.ps1` et placez-le dans un dossier de votre choix. +2. C'est tout. + +--- + +## Premier lancement + +### Étape 1 — Débloquer le fichier (première fois uniquement) + +Windows peut bloquer les fichiers téléchargés depuis Internet. Pour lever ce blocage : + +1. Faites un **clic droit** sur `cadMasterCLI.ps1` +2. Cliquez sur **Propriétés** +3. En bas de la fenêtre, cochez **Débloquer** si la case est présente +4. Cliquez sur **OK** + +> Si la case "Débloquer" n'apparaît pas, l'étape n'est pas nécessaire. + +### Étape 2 — Autoriser l'exécution des scripts (première fois uniquement) + +Si un message d'erreur apparaît à propos de la "stratégie d'exécution" : + +1. Appuyez sur la touche **Windows**, tapez `PowerShell` +2. Faites un clic droit sur **Windows PowerShell** → **Exécuter en tant qu'administrateur** +3. Copiez-collez la commande suivante et appuyez sur Entrée : + +``` +Set-ExecutionPolicy RemoteSigned -Scope CurrentUser +``` + +4. Tapez `O` pour confirmer, puis fermez la fenêtre PowerShell. + +### Étape 3 — Lancer cadMasterCLI + +**Méthode simple :** faites un **clic droit** sur `cadMasterCLI.ps1` → **Exécuter avec PowerShell**. + +**Méthode alternative :** +1. Ouvrez PowerShell (touche Windows → tapez `PowerShell` → Entrée) +2. Naviguez vers le dossier contenant le fichier, par exemple : + ``` + cd C:\Outils\cadMasterCLI + ``` +3. Lancez le script : + ``` + .\cadMasterCLI.ps1 + ``` + +--- + +## Utilisation + +### 1. Sélectionner un script + +Au démarrage, une fenêtre de sélection s'affiche avec la liste des scripts disponibles. + +| Colonne | Signification | +|---|---| +| Nom | Nom du script | +| Description | Ce que fait le script | +| Mis à jour | Date de la dernière mise à jour | +| Cache local | Indique si le script a déjà été téléchargé | +| MAJ dispo | `[NOUVEAU]` si une mise à jour est disponible | + +Double-cliquez sur le script souhaité, ou sélectionnez-le et cliquez sur **OK**. + +> Pour fermer sans rien exécuter, fermez simplement la fenêtre. + +### 2. Remplir les paramètres + +Une fenêtre s'ouvre avec : + +- **À gauche** : la documentation du script (README), pour comprendre à quoi il sert et comment le remplir. +- **À droite** : le formulaire de paramètres à remplir. + +**Types de champs :** + +| Apparence | Ce qu'il faut faire | +|---|---| +| Champ texte blanc | Saisir une valeur (adresse IP, nom d'utilisateur, etc.) | +| Boutons ronds (RadioButtons) | Sélectionner une option parmi les choix proposés | +| Case à cocher | Activer ou désactiver une option | +| Bouton **Parcourir...** | Choisir un fichier CSV sur votre ordinateur | + +Les champs marqués **Obligatoire** doivent impérativement être remplis avant de pouvoir lancer le script. Le bouton **Lancer le script** reste grisé tant que ces champs sont vides — il devient vert une fois tout renseigné. + +Cliquez sur **[?] Voir l'aide** sous un champ pour afficher une description détaillée de ce paramètre. + +**Panneau README :** +- Cliquez sur **Fermer README** pour masquer la documentation et agrandir le formulaire. +- Cliquez sur **Ouvrir README** pour la réafficher. +- Vous pouvez redimensionner le panneau README en faisant glisser la barre de séparation entre les deux zones. + +### 3. Lancer le script + +Une fois tous les champs obligatoires remplis : + +- Cliquez sur **Lancer le script** (bouton vert). +- Le script s'exécute dans le terminal. Attendez la fin de l'exécution. +- Appuyez sur **Entrée** pour fermer. + +> Cliquez sur **Annuler** pour revenir à la liste des scripts sans rien exécuter. + +--- + +## Mise à jour automatique des scripts + +Lorsqu'une nouvelle version d'un script est disponible sur le serveur, cadMasterCLI vous le signale avec `[NOUVEAU]` dans la liste et vous propose de télécharger la mise à jour. + +Les scripts sont stockés localement dans le sous-dossier `scripts\` à côté de `cadMasterCLI.ps1`. + +--- + +## Mode hors ligne + +Si le serveur Gitea est inaccessible (pas de réseau), cadMasterCLI utilise automatiquement les scripts déjà téléchargés. Un message vous prévient que vous êtes en mode hors ligne. + +--- + +## Cas d'erreurs fréquents + +| Message | Cause probable | Solution | +|---|---|---| +| Erreur de stratégie d'exécution | PowerShell bloque les scripts | Voir **Étape 2** du premier lancement | +| Impossible de contacter Gitea | Pas d'accès réseau | Vérifiez votre connexion ou utilisez le mode hors ligne | +| Script introuvable en cache | Script jamais téléchargé + pas de réseau | Connectez-vous au réseau et relancez | +| Fichier bloqué par Windows | Script téléchargé depuis Internet | Voir **Étape 1** du premier lancement | + +--- + +## Structure des fichiers + +``` +cadMasterCLI/ +├── cadMasterCLI.ps1 ← fichier principal à lancer +├── README.md ← cette documentation +├── CONTRIBUTING_SCRIPTS.md ← guide pour créer de nouveaux scripts +├── _template_script.ps1 ← modèle de script +└── scripts/ ← scripts téléchargés (créé automatiquement) + └── NomDuScript/ + └── NomDuScript.ps1 +```