musique/README.md

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 (tryb release)
• make debug - Buduje interpreter bin/debug/musique (tryb debug)
• make clean - Usuwa reprodukowalne elementy projektu (automatycznie stworzone pliki binarne czy raporty)

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
└── src            Główny katalog z kodem źródłowym
    └── tests      Katalog z testami jednostkowymi