From 82713060649a849f8082134a2ed15fdc38df606d Mon Sep 17 00:00:00 2001 From: Killian Meersman Date: Sun, 18 Feb 2024 01:10:24 +0100 Subject: [PATCH] Improve README.md --- Makefile | 2 +- README.md | 20 ++++++++++++++++++++ 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 0baed18..f3313ed 100644 --- a/Makefile +++ b/Makefile @@ -11,7 +11,7 @@ test: install: build sudo cp -f bin/supermake /usr/local/bin/supermake - sudo cp -lf /usr/local/bin/supermake /usr/local/bin/smake + sudo cp -lf /usr/local/bin/supermake /usr/local/bin/smake uninstall: sudo rm -f /usr/local/bin/supermake diff --git a/README.md b/README.md index 9c22524..cca1772 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,26 @@ It offers builtin parallelism and container support, all using the a Makefile-li 3. Run (part of) your recipes in different shells, interpreters and even containers 🐳. 5. Make-like syntax. Re-purpose your Makefiles with a few tweaks. +## Installation +Grab a pre-built executable from the [latest release](https://github.com/KillianMeersman/Supermake/releases/latest/) or build it yourself. +```bash +git clone git@github.com:KillianMeersman/Supermake.git +cd Supermake +make install +``` + +## Usage +Once installed, it's as simple as running +```bash +smake run +``` + +If you want to find out more, you can use the `help` command and/or flag. +```bash +smake help +smake run --help +``` + ## Example ```Makefile TAG ?= latest # Inherit from environment variable, using 'latest' as fallback