From 655cc57cde079413c020dd263670b5c79091f1e7 Mon Sep 17 00:00:00 2001 From: Robert Bendun Date: Sun, 8 May 2022 18:20:44 +0200 Subject: [PATCH] readme - dokumentacja --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4e2d6da..b9b542e 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,33 @@ # Musique interpreter +Interpreter języka Musique. Możliwy do wykorzystywania jako: + +- biblioteka interpretera języka dołączana do innego projektu (podobnie jak Lua); +- REPL działający w systemie GNU/Linux + ALSA wykonujący język Musique. + ## Dostępne komendy - `make` - Buduje interpreter `bin/musique` - `make clean` - Usuwa reprodukowalne elementy projektu (automatycznie stworzone pliki binarne czy raporty) -- `make unit-test-coverage` - Uruchamia raport pokrycia kodu przez testy jednostkowe + +### Dokumentacja + +- `make doc` - Tworzy `doc/build/html/` zawierający dokumentację projektu + +### Testowanie + - `make unit-tests` - Uruchamia testy jednostkowe interpretera +- `make unit-test-coverage` - Uruchamia raport pokrycia kodu przez testy jednostkowe ## Budowa projektu ``` . ├── bin Miejsce produkcji plików wykonywalnych +├── coverage ├── doc Dokumentacja języka, interpretera +│   ├── build Miejsce produkcji dokumentacji +│   └── source Źródła dokumentacji Sphinx ├── lib Zewnętrzne zależności projektu │   ├── expected │   └── ut