From ab2b1aedba63d17fee241c8ee63ac4232c54e616 Mon Sep 17 00:00:00 2001
From: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
Date: Sat, 29 Jul 2023 14:14:12 +0200
Subject: [PATCH] meta: add help message for make file

Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
---
 Makefile | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/Makefile b/Makefile
index a089eb4d..43af85ea 100644
--- a/Makefile
+++ b/Makefile
@@ -5,7 +5,6 @@ ARGS=""
 
 default: fmt
 	$(CC) build
-	@make example
 
 doc-deps:
 	$(CC) install mdbook
@@ -13,26 +12,27 @@ doc-deps:
 fmt:
 	$(CC) fmt --all
 
-check:
+check: ## Runs unit testing
 	$(CC) test $(ARGS)
 
-example:
-	@echo "No example for the moment"
-
-clean:
+clean: ## Clean up everythings
 	$(CC) clean
 
-book:
+book: ## Build the release version of documentation
 	cd docs/docs-book; mdbook build
 
-dev-book:
+dev-book: ## Build the docs in dev mode
 	cd docs/docs-book; mdbook serve --open
 
-install:
+install: ## Install coffee inside the local machine
 	$(CC) install --locked --path ./coffee_cmd
 
-integration: default
+integration: default ## Runs integration testing
 	$(CC) test -j 4 -p tests $(ARGS)
 
 setup:
 	git config core.hooksPath .githooks
+
+help: ## Show Help
+	@grep --no-filename -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | \
+	awk 'BEGIN {FS = ":.*?## "}; {printf "\033[32m%-15s\033[0m %s\n", $$1, $$2}'