Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add installation guide #2

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add installation guide #2

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e0d706a
Add installation guide
ad-m Jun 12, 2021
cdb30e2
Apply review comments
ad-m Jun 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion README.md
View file
Open in desktop
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 && chmod +x /usr/local/bin/cake
```

or

```bash
curl -L -s "https://raw.githubusercontent.com/wurosh/cake/master/cake" -o ~/.local/bin/cake && chmod +x ~/.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