3 releases (breaking)

new 0.3.0 Sep 15, 2020
0.2.0 Sep 14, 2020
0.1.0 Sep 11, 2020


188 lines

Pretty Make

Make Make pretty.

This program intend to extend Make capabilities. Actually it parse a Makefile to produce a pretty help. See example below:

🚧 screenshot

🏁 Installation

Per project by downloading the binary

To use Pretty Make you only have to add the following at the end of your Makefile:

	@bash <(curl -Ls https://raw.githubusercontent.com/awea/pretty-make/master/scripts/install.sh)

.PHONY: help
## List available commands
help: bin/pretty-make
	@bin/pretty-make Makefile

System-wide using cargo

First you have to install Pretty Make using the following command:

cargo install pretty-make

Then you can use Pretty Make in your Makefile like this:

.PHONY: help
## List available commands
  @pretty-make Makefile

⌨️ Usage

make help

📝 Makefile help syntax

#@name Name of your project
#@description A short description of your project (optional)
#@color-title #a6cc70 (optional)
#@color-subtitle #ffcc66 (optional)
#@color-link #77a8d9 (optional)

## A description of my awesome-command

# A comment (which won't appear in the help)

## A description of my other command
## on multiple lines!

✍️ Authors

🤜🤛 Contributing

Contributions, issues and feature requests are welcome! See the list of contributors who participated in this project.

📄 License

Pretty Make is licensed under the GNU General Public License v3.0.


~69K SLoC