Skip to content

Commit

Permalink
Improve README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KillianMeersman committed Feb 18, 2024
1 parent 0e79cbe commit 8271306
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <target>
```

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
Expand Down

0 comments on commit 8271306

Please sign in to comment.