From d6cd69e659f12904e144c21b52c8562f64c7b143 Mon Sep 17 00:00:00 2001 From: LouisJackman <11330428+LouisJackman@users.noreply.github.com> Date: Fri, 15 May 2020 07:51:21 +0100 Subject: [PATCH] Add make help target --- Makefile | 22 +++++++++++++++++++++- README.md | 2 ++ 2 files changed, 23 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 4f872ad7..581ddbae 100644 --- a/Makefile +++ b/Makefile @@ -306,5 +306,25 @@ test-install: cd test/install && jpm --verbose --test --modpath=./modpath install https://github.com/janet-lang/path.git cd test/install && jpm --verbose --test --modpath=./modpath install https://github.com/janet-lang/argparse.git +help: + @echo + @echo 'Janet: A Dynamic Language & Bytecode VM' + @echo + @echo Usage: + @echo ' make Build Janet' + @echo ' make repl Start a REPL from a built Janet' + @echo + @echo ' make test Test a built Janet' + @echo ' make valgrind Assess Janet with Valgrind' + @echo ' make callgrind Assess Janet with Valgrind, using Callgrind' + @echo ' make dist Create a distribution tarball' + @echo ' make docs Generate documentation' + @echo ' make install Install into the current filesystem' + @echo ' make uninstall Uninstall from the current filesystem' + @echo ' make clean Clean intermediate build artifacts' + @echo " make format Format Janet's own source files" + @echo ' make grammar Generate a TextMate language grammar' + @echo + .PHONY: clean install repl debug valgrind test \ - valtest emscripten dist uninstall docs grammar format + valtest emscripten dist uninstall docs grammar format help diff --git a/README.md b/README.md index 5a2fa674..595bd72a 100644 --- a/README.md +++ b/README.md @@ -88,6 +88,8 @@ make test make repl ``` +Find out more about the available make targets by running `make help`. + ### 32-bit Haiku 32-bit Haiku build instructions are the same as the unix-like build instructions,