Skip to content

Commit

Permalink
Add installation guide
Browse files Browse the repository at this point in the history
  • Loading branch information
ad-m authored Jun 12, 2021
1 parent 533536f commit 636829b
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,20 @@ tools like [act](https://github.com/nektos/act) without being tied to a specific
forge.

## How-To
To install use following command:

```bash
sudo curl -L -s "https://raw.githubusercontent.com/wurosh/cake/master/cake" -o /usr/local/bin/cake
```

or

```bash
curl -L -s "https://raw.githubusercontent.com/wurosh/cake/master/cake" -o ~/.local/bin/cake
```

Ensure environment variable `PATH` includes `/usr/local/bin` or `~/.local/bin/` accordingly.

Just use `cake` instead of `make`. The defaults should fit most use cases.

If you really have to, you can specify additional `docker`/`podman` arguments
Expand Down Expand Up @@ -54,7 +68,6 @@ CAKE_DOCKERFILES='subdir/one.dockerfile subdir/Dockerfile' cake


## Tips

If I want to debug my development container, I like to add a `shell` target
to my `Makefile` like so:
``` makefile
Expand Down

0 comments on commit 636829b

Please sign in to comment.