Describe makefile options in readme

2022-05-02 22:12:29 +02:00 · 2022-05-02 22:12:29 +02:00 · 79d96aa935
commit 79d96aa935
parent c8acceb329
2 changed files with 8 additions and 1 deletions
--- a/2
+++ b/2
@ -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

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

 ```