diff --git a/README.md b/README.md index 2330f7b..788d82c 100644 --- a/README.md +++ b/README.md @@ -1 +1,51 @@ # C-repl + +> Alaric Patault +> Augustin Lucas + + +## Exécution + +#### Dépendances: + +``` +g++ >= 10 +``` + +#### Compilation +```bash +make -j +``` + +#### Exécution +```bash +build/main +``` + +### Arguments + +La commande `build/main -h` pourrait être plus à jour que ce fichier +``` +Usage: build/main [OPTIONS] + + --help | -h Afficher cette aide + --tokens | -t Afficher les tokens lus + --ast | -a Afficher l'AST créé + --type-memory | -T Afficher le contenu de la mémoire de types avant exécution + --memory | -m Afficher le contenu de la mémoire après exécution +``` + +### Tests + +```bash +make -j run-tests +``` + +Si l'erreur suivante s'affiche, ré-exécuter la commande, c'est à cause de la manière dont make comprend les choses +`/bin/sh: ligne 3: build/test-*: Aucun fichier ou dossier de ce type` + +### Examples + +```bash +build/main < example/[fichier].c +``` \ No newline at end of file