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.

Files for makefile-help, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size makefile_help-0.1.1-py3-none-any.whl (4.3 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size makefile-help-0.1.1.tar.gz (3.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page