Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ntorresalberto committed Mar 12, 2024
1 parent 4149b72 commit d334f72
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,25 @@ It allows using rootless containers, running GUIs, quickly mounting your current

Even though **dogi** was originally inspired by [rocker](https://github.com/osrf/rocker) and solves a similar problem (or the same), it aims to do so with minimum user effort. Additionally, it provides the ability to interact with the `docker` client directly ([transparent](#design-principles)).

## Install & Try
## Quickstart

```bash
CGO_ENABLED=0 go install -a github.com/ntorresalberto/dogi@latest
dogi run ubuntu
# install binary
wget -qO- https://github.com/ntorresalberto/dogi/releases/download/rolling/dogi-rolling-linux-amd64.tar.gz | tar xvz -C ~/go/bin

# optional step to add autocompletion
# add bash autocompletion
echo 'source <(dogi completion bash)' >> ~/.bashrc

# try it!
dogi run ubuntu

# update it easily
dogi update
```

To update `dogi` use: `dogi update`
Some [optional setup steps](#optional-setup-steps) might be required.

**NOTE:** some [optional setup steps](#optional-setup-steps) might be required.
**NOTE:** You can also install from source: `CGO_ENABLED=0 go install -a github.com/ntorresalberto/dogi@latest`

---

Expand Down Expand Up @@ -145,6 +151,8 @@ sudo apt install golang # ubuntu >= 22.04
sudo snap install go --classic
```

---

**bash: dogi: command not found**

This error message means your `$PATH` doesn't include the go binaries path.
Expand All @@ -154,6 +162,8 @@ echo "alias dogi=$(go env GOPATH)/bin/dogi" >> ~/.bashrc
source .bashrc
```

---

**dogi: /lib/x86_64-linux-gnu/libc.so.6: version `GLIBC_2.32' not found (required by dogi)**

This error is usually caused by a container running an older version of glibc than your host system (where you compiled `dogi`).
Expand Down

0 comments on commit d334f72

Please sign in to comment.