Skip to content

Commit

Permalink
meta: add help message for make file
Browse files Browse the repository at this point in the history
Signed-off-by: Vincenzo Palazzo <[email protected]>
  • Loading branch information
vincenzopalazzo committed Feb 6, 2024
1 parent 2dd8250 commit ab2b1ae
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,34 +5,34 @@ ARGS=""

default: fmt
$(CC) build
@make example

doc-deps:
$(CC) install mdbook

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}'

0 comments on commit ab2b1ae

Please sign in to comment.