docs: add repository documentation
This commit is contained in:
@@ -0,0 +1,60 @@
|
||||
# Script
|
||||
|
||||
## Résumé
|
||||
|
||||
Ce dépôt sert à versionner des scripts utilisés pour TipEdge.
|
||||
|
||||
À ce stade, le contenu versionné visible est minimal. Aucun script exécutable, outil de build ou suite de tests n’est présent dans le dépôt.
|
||||
|
||||
## Objectif et cas d’usage
|
||||
|
||||
- centraliser les scripts liés à TipEdge
|
||||
- suivre leur évolution dans Git
|
||||
- fournir une base simple pour ajouter ou maintenir ces scripts
|
||||
|
||||
## Technologies visibles
|
||||
|
||||
- Git
|
||||
- Gitea comme forge distante visible dans la configuration Git
|
||||
- fichier d’environnement d’exemple : [`.env.exemple`](/home/boudetk/Script/.env.exemple)
|
||||
|
||||
## Prérequis
|
||||
|
||||
Aucun prérequis technique précis n’est vérifiable dans le dépôt pour le moment.
|
||||
|
||||
## Installation
|
||||
|
||||
La seule étape vérifiable est le clonage du dépôt.
|
||||
|
||||
```bash
|
||||
git clone <url-du-depot>
|
||||
cd Script
|
||||
```
|
||||
|
||||
## Dépendances importantes
|
||||
|
||||
Aucune dépendance applicative n’est visible dans le dépôt.
|
||||
|
||||
## Configuration
|
||||
|
||||
Un fichier [`.env.exemple`](/home/boudetk/Script/.env.exemple) est présent, mais il est vide dans l’état actuel du dépôt.
|
||||
|
||||
La configuration réellement nécessaire n’est donc pas vérifiable pour le moment.
|
||||
|
||||
## Commandes utiles
|
||||
|
||||
Aucune commande de lancement, de développement, de test ou de build n’est définie dans le dépôt.
|
||||
|
||||
## Structure du projet
|
||||
|
||||
La structure visible est actuellement très simple :
|
||||
|
||||
- [README.md](/home/boudetk/Script/README.md) : documentation du dépôt
|
||||
- [AGENTS.md](/home/boudetk/Script/AGENTS.md) : règles de travail pour les agents
|
||||
- [`.env.exemple`](/home/boudetk/Script/.env.exemple) : exemple de configuration, actuellement vide
|
||||
|
||||
## Points d’attention
|
||||
|
||||
- Le dépôt ne contient pas encore de scripts versionnés visibles.
|
||||
- Aucune convention technique, stack applicative ou procédure d’exécution n’est documentée dans les fichiers présents.
|
||||
- Toute documentation plus détaillée demanderait des scripts, configurations ou consignes supplémentaires dans le dépôt.
|
||||
|
||||
Reference in New Issue
Block a user