From 79d96aa9352c549179a2f4cc896e906d24f6fe80 Mon Sep 17 00:00:00 2001 From: Robert Bendun Date: Mon, 2 May 2022 22:12:29 +0200 Subject: [PATCH] Describe makefile options in readme --- Makefile | 2 +- README.md | 7 +++++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 9ac1951..5bf3d39 100644 --- a/Makefile +++ b/Makefile @@ -31,7 +31,7 @@ bin/unit-tests: src/tests/*.cc $(Obj) g++ $(CXXFLAGS) $(CPPFLAGS) -o $@ $^ clean: - rm -rf bin + rm -rf bin coverage .PHONY: clean diff --git a/README.md b/README.md index 0533fbb..db7b1ad 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,12 @@ # Musique interpreter +## Dostępne komendy + +- `make` - Buduje interpreter `bin/musique` +- `make clean` - Usuwa reprodukowalne elementy projektu (automatycznie stworzone pliki binarne czy raporty) +- `make unit-tests-coverage` - Uruchamia raport pokrycia kodu przez testy jednostkowe +- `make unit-tests` - Uruchamia testy jednostkowe interpretera + ## Budowa projektu ```