From 71ea04ffcc3615d63eda5fbb56b0d2880de70f02 Mon Sep 17 00:00:00 2001
From: Daniel <daniel@harvey>
Date: Thu, 26 Nov 2020 17:25:41 +0100
Subject: [PATCH] DOC: Help for Makefile.

---
 Makefile | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

diff --git a/Makefile b/Makefile
index c7c2b77..b2b57fc 100644
--- a/Makefile
+++ b/Makefile
@@ -21,7 +21,7 @@
 
 # Just a collection of scripts
 
-.PHONY: all autopep8 test
+.PHONY: all autopep8 test help
 
 # Do the integration tests.
 # Accepts freestyle arguments like so:
@@ -29,9 +29,26 @@
 test:
 	cd tests &&	pytest $(test_opts)
 
+
+# Just print the help.
+define HELP
+The most common targets:
+
+make test :: Do the integration tests.  Accepts freestyle arguments like so:
+             `make test test_opts=test_foo.py -k test_function`
+Prepare everything for running.
+make autopep8 :: Autoformatting for all tests
+make all :: Run autopep8 and test
+endef
+export HELP
+help:
+	@echo "$$HELP"
+
+
 # Run the tests through autopep8.
 autopep8:
 	autopep8 -ri tests
 
+
 # Meta target to call the other targets.
 all: autopep8 test
-- 
GitLab