From d7043e11079dc3aac5b10533c7276c9bd1400e01 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81d=C3=A1m=20Kov=C3=A1cs?= Date: Mon, 17 Jul 2023 17:46:38 +0200 Subject: [PATCH] Add docker instructions to README --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index bc15ae2..b9c7666 100644 --- a/README.md +++ b/README.md @@ -16,4 +16,17 @@ sudo chmod +x /usr/local/bin/alma This PowerShell command will download the alma.exe to the current folder. Move it to a folder that is in PATH. ``` Invoke-WebRequest https://github.com/ADIX7/Alma/releases/download/latest/Alma.exe -OutFile alma.exe +``` + +**As a Docker tool** + +You can run it with Docker/Podman. You should mount every directory (source and target too) to the same path as they are on the host. +For example, if you have your dotfiles cloned to your home folder and you have your repository.json in ~/.config/alma/repository.json, then you can run this command and the links will be correct on the host. +``` +docker run --rm -it -v /home/myuser:/home/myuser -e "HOME=/home/myuser" adix7/alma:latest ... +``` + +If you don't have repository.json, you can set the WORKDIR (or ALMA_WORKDIR) env var to your repository. For example, if you cloned your dotfiles to ~/dotfiles, you can use this command. +``` +docker run --rm -it -v /home/myuser:/home/myuser -e "WORKDIR=/home/myuser/dotfiles" adix7/alma:latest ... ``` \ No newline at end of file