Metadata-Version: 2.1
Name: makefile-help
Version: 0.1.0
Summary: Autogenerates pretty Makefile help
Home-page: https://github.com/simonwardjones/makefile-help
License: MIT
Author: simonwardjones
Author-email: simonwardjones@yahoo.co.uk
Requires-Python: >=3.7,<4.0
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Terminals
Description-Content-Type: text/markdown

# Makefile help

This small package helps by generating colourful help for Makefiles.
- [Makefile help](#makefile-help)
    - [Why?](#why)
    - [Usage](#usage)
    - [Installation](#installation)

---
### 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`
