diff --git a/README.md b/README.md index 846b9ac..288c739 100644 --- a/README.md +++ b/README.md @@ -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` --- @@ -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. @@ -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`).