readme - dokumentacja

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