Suppression du script test.sh, mise à jour du Makefile et ajout de sections dans le README.md pour l'installation, l'utilisation et les tests.
This commit is contained in:
38
README.md
38
README.md
@@ -2,11 +2,49 @@
|
||||
|
||||
## Sommaire 📖
|
||||
- [Introduction](#introduction)
|
||||
- [Installation](#installation)
|
||||
- [Utilisation](#utilisation)
|
||||
- [Tests](#tests)
|
||||
- [Documentation](#documentation)
|
||||
- [Auteurs](#auteurs-%F0%9F%91%A8%E2%80%8D%F0%9F%92%BB)
|
||||
|
||||
## Introduction
|
||||
Bake est un utilitaire de compilation inspiré de `make`, conçu pour gérer la génération et la mise à jour de fichiers en fonction de leurs dépendances. Contrairement à `make`, Bake utilise un fichier de configuration nommé `Bakefile`, avec une syntaxe simplifiée et sans certaines fonctionnalités avancées.
|
||||
|
||||
## Installation
|
||||
```bash
|
||||
# Cloner le dépôt
|
||||
git clone https://grond.iut-fbleau.fr/stiti/SAE32_2024/
|
||||
cd SAE32_2024
|
||||
|
||||
# Compiler le projet et diffuser le .JAR dans tout les répertoires de tests
|
||||
make
|
||||
```
|
||||
|
||||
## Utilisation
|
||||
```bash
|
||||
# Utilisation dans les répertoires de test `bake`
|
||||
java -cp bakefile.jar fr.monlouyan.bakefile.Main
|
||||
```
|
||||
|
||||
## Tests
|
||||
Le répertoire **tests** contient une liste de tests pour vérifier que Bake réagit comme Make.
|
||||
- **[Accéder au répertoire de tests](./tests)**
|
||||
- **Contenu**:
|
||||
- **[README.md](./tests/README.md)** : Documentation qui explique l'utilisation des tests.
|
||||
- **[C](./tests/C)** : Répertoire qui contient les tests en C.
|
||||
- **[Java](./tests/Java)** : Répertoire qui contient les tests en Java.
|
||||
|
||||
Les dossiers de test sont organisés par langage (C, Java) et chaque test possède son propre script `run_testXX.sh` pour exécuter les tests correspondants.
|
||||
|
||||
## Documentation
|
||||
Le répertoire **documentation** contient un rapport et des diagrammes détaillant le fonctionnement de Bake.
|
||||
- **[Accéder au répertoire de documentation](./documentation)**
|
||||
- **Contenu**:
|
||||
- **[rapport.pdf](./documentation/rapport.pdf)** : Rapport détaillant le projet Bake.
|
||||
- **[Diagrammes](./documentation/Diagrammes)** : Répertoire contenant les diagrammes UML et autres schémas explicatifs.
|
||||
|
||||
|
||||
## Auteurs 👨💻
|
||||
- Moncef STITI - [@stiti](https://grond.iut-fbleau.fr/stiti)
|
||||
- Louay DARDOURI - [@dardouri](https://grond.iut-fbleau.fr/dardouri)
|
||||
|
||||
Reference in New Issue
Block a user