Skip to content

Commit c87ffc4

Browse files
meta: add help message for make file
Signed-off-by: Vincenzo Palazzo <[email protected]>
1 parent 158d18e commit c87ffc4

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

Makefile

+10-10
Original file line numberDiff line numberDiff line change
@@ -5,34 +5,34 @@ ARGS=""
55

66
default: fmt
77
$(CC) build
8-
@make example
98

109
doc-deps:
1110
$(CC) install mdbook
1211

1312
fmt:
1413
$(CC) fmt --all
1514

16-
check:
15+
check: ## Runs unit testing
1716
$(CC) test $(ARGS)
1817

19-
example:
20-
@echo "No example for the moment"
21-
22-
clean:
18+
clean: ## Clean up everythings
2319
$(CC) clean
2420

25-
book:
21+
book: ## Build the release version of documentation
2622
cd docs/docs-book; mdbook build
2723

28-
dev-book:
24+
dev-book: ## Build the docs in dev mode
2925
cd docs/docs-book; mdbook serve --open
3026

31-
install:
27+
install: ## Install coffee inside the local machine
3228
$(CC) install --locked --path ./coffee_cmd
3329

34-
integration: default
30+
integration: default ## Runs integration testing
3531
$(CC) test -j 4 -p tests $(ARGS)
3632

3733
setup:
3834
git config core.hooksPath .githooks
35+
36+
help: ## Show Help
37+
@grep --no-filename -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | \
38+
awk 'BEGIN {FS = ":.*?## "}; {printf "\033[32m%-15s\033[0m %s\n", $$1, $$2}'

0 commit comments

Comments
 (0)