musique/README.md

37 lines
1.2 KiB
Markdown
Raw Normal View History

2022-04-24 15:27:09 +02:00
# Musique interpreter
2022-04-24 16:13:02 +02:00
2022-05-08 18:20:44 +02:00
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.
2022-05-02 22:12:29 +02:00
## Dostępne komendy
- `make` - Buduje interpreter `bin/musique`
- `make clean` - Usuwa reprodukowalne elementy projektu (automatycznie stworzone pliki binarne czy raporty)
2022-05-08 18:20:44 +02:00
### Dokumentacja
- `make doc` - Tworzy `doc/build/html/` zawierający dokumentację projektu
### Testowanie
2022-05-02 22:12:29 +02:00
- `make unit-tests` - Uruchamia testy jednostkowe interpretera
2022-05-08 18:20:44 +02:00
- `make unit-test-coverage` - Uruchamia raport pokrycia kodu przez testy jednostkowe
2022-05-02 22:12:29 +02:00
2022-04-24 16:13:02 +02:00
## Budowa projektu
```
.
├── bin Miejsce produkcji plików wykonywalnych
2022-05-08 18:20:44 +02:00
├── coverage
2022-04-24 16:13:02 +02:00
├── doc Dokumentacja języka, interpretera
2022-05-08 18:20:44 +02:00
│   ├── build Miejsce produkcji dokumentacji
│   └── source Źródła dokumentacji Sphinx
2022-04-24 16:13:02 +02:00
├── lib Zewnętrzne zależności projektu
│   ├── expected
│   └── ut
└── src Główny katalog z kodem źródłowym
└── tests Katalog z testami jednostkowymi
```