diff --git a/Makefile b/Makefile index 73b92f6..b0362c8 100644 --- a/Makefile +++ b/Makefile @@ -15,10 +15,10 @@ run: all test: all @$(ERL) -noshell $(EPATH) -s $(PROJECT)_test test -s init stop -examples: all +example: all @$(ERL) -noshell $(EPATH) -s ex1 test -s init stop -doc: all +docs: all @$(ERL) -noshell $(EPATH) \ -eval "edoc:files(filelib:wildcard(\"$(SOURCES)\"), [$(DOC_OPTS)])" \ -s init stop diff --git a/README.markdown b/README.markdown index 65abf76..3603b9c 100644 --- a/README.markdown +++ b/README.markdown @@ -15,7 +15,11 @@ Installation ------------ To compile the module you simply run 'make'. + To run the unit tests run 'make test'. + +To run the example module run 'make example'. + To build the (very) limited documentation run 'make docs'.