Self-Documenting Makefile

Last updated on 1 min read 
#
# Self-Documenting Makefile using '##' descriptions
#
# Original Reference: https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
#

.PHONY
task: ## This awesome task does everything!
  @echo "Nope."

help: Makefile
		@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'

.DEFAULT_GOAL := help

Gist

Makefile Linux C
Avatar
Alex Lapinski
Passionate Software Engineer and Architect

I am a Software Engineer and Architect. Most of my interests are around software development, service architecture and general tinkering around.

I typically will play around with tools ranging from DevOps, Infrastructure and other hardware platforms (RapsberryPi) to novel database engines and new software architectures as well as machine learning and artificial intelligence (really just complex computer science).

When I’m not working, I’ll be found playing a plethora of strategy games, or board games with the family.

Related