Musique language interpreter

Go to file

Robert Bendun 52ef323284 Colorless when `NO_COLOR` env variable exists In accordance to https://no-color.org/ standard		2022-05-17 02:56:28 +02:00
doc	Requirements for documentation generation	2022-05-08 18:14:55 +02:00
examples	Scoped variables, single namespace variables and functions	2022-05-17 02:35:51 +02:00
lib	Let's go!	2022-04-24 15:27:09 +02:00
src	Colorless when `NO_COLOR` env variable exists	2022-05-17 02:56:28 +02:00
.gitignore	Doxygen & Sphinx documentation tooling	2022-05-08 18:02:23 +02:00
.gitlab-ci.yml	Started unit testing	2022-04-24 16:10:29 +02:00
Doxyfile	Doxygen & Sphinx documentation tooling	2022-05-08 18:02:23 +02:00
Makefile	Scoped variables, single namespace variables and functions	2022-05-17 02:35:51 +02:00
README.md	readme - dokumentacja	2022-05-08 18:20:44 +02:00

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
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