Réécriture de README

This commit is contained in:
Cédric Abonnel 2023-11-19 19:20:28 +01:00
parent 0f003a6bb5
commit 53890fc4c4
1 changed files with 16 additions and 12 deletions

View File

@ -1,27 +1,31 @@
# scripts-bash
Some bash scripts
Quelques scripts Bash
Le script `install.sh` a été créé pour automatiser le processus de copie de fichiers depuis un dépôt Git local vers un répertoire local, en préservant la structure des fichiers et en renommant les fichiers pour supprimer leurs extensions. Le script a également la capacité d'ajouter le répertoire de destination au chemin d'accès (PATH) de l'utilisateur.
Le script `install.sh` a été conçu pour automatiser le processus de copie de fichiers depuis un dépôt Git local vers un répertoire local.
Le script modifie également le chemin d'accès (PATH) de l'utilisateur ainsi que le chemin d'accès de man (MANPATH) de l'utilisateur.
## Utilisation
Pour utiliser ces scripts, suivez ces étapes :
1. Clonez ce dépôt Git
2. Assurez-vous que le script est exécutable en utilisant la commande `chmod +x copy_files.sh`.
3. Exécutez le script en utilisant `./install.sh`.
1. Clonez ce dépôt Git.
2. Exécutez le script en utilisant la commande `./install.sh`.
Toutes les opérations et les messages d'erreur sont enregistrés dans un fichier journal (`~/log/copy_files.log`) situé dans le répertoire personnel de l'utilisateur. Le journal comprend la date, l'heure, le numéro de processus (PID) et les messages d'exécution du script.
Toutes les opérations et les messages d'erreur sont enregistrés dans un fichier journal (`~/log/a5l-scripts_bash-<date et heure de l'instant>-<PID>.log`) situé dans le répertoire personnel de l'utilisateur. Le journal inclut la date, l'heure et les détails de chaque opération.
Le chemin complet des fichiers copiés est enregistré de manière unique dans le fichier `~/.config/a5l_scripts-bash_uninstall-list`.
## Documentation
Le dossier `local/share/doc` contient la documentation de chaque script.
Le dossier `local/share/man/man1` contient la documentation de chaque script au format MAN.
## Désinstallation
Le script `uninstall.sh` permet de supprimer tous les fichiers précédemment copiés avec le script `install.sh`, en se basant sur le fichier utilisateur `~/.config/a5l_scripts-bash_uninstall-list`.
# License
Shield: [![CC BY-SA 4.0][cc-by-sa-shield]][cc-by-sa]
This work is licensed under a
[Creative Commons Attribution-ShareAlike 4.0 International License][cc-by-sa].
# Licence
Ce travail est sous licence [Creative Commons Attribution-ShareAlike 4.0 International License][cc-by-sa].
[![CC BY-SA 4.0][cc-by-sa-image]][cc-by-sa]
[cc-by-sa]: http://creativecommons.org/licenses/by-sa/4.0/
[cc-by-sa-image]: https://licensebuttons.net/l/by-sa/4.0/88x31.png
[cc-by-sa-shield]: https://img.shields.io/badge/License-CC%20BY--SA%204.0-lightgrey.svg