Skip to main content

Autogenerates pretty Makefile help

Project description

Makefile help

This small package helps by generating colourful help for Makefiles.


Why?

I often store useful commands in Makefiles and then promptly forget them.


Usage

At the top of a Makefile add the following (assuming makefile-help is installed in the current virtual env):

help: # @@Utils@@ Display help and exit
	python -m makefile_help

Comment each command with a description and optionally a section using @@
The makefile_help script will then generate a help string.

../makefile-help/image/demo.gif


Installation

pip install makefile-help

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

makefile-help-0.1.1.tar.gz (3.7 kB view hashes)

Uploaded Source

Built Distribution

makefile_help-0.1.1-py3-none-any.whl (4.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page