From: Daan De Meyer <daan.j.demeyer@gmail.com>
Date: Thu, 19 Dec 2024 09:33:00 +0000 (+0100)
Subject: Recommend symlinking to ~/.local/bin
X-Git-Tag: v25~109
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=aef2a2169ca325de26c017a76e95e581e54f30af;p=thirdparty%2Fmkosi.git

Recommend symlinking to ~/.local/bin

When using mkosi sandbox with a tools tree, /usr is replaced which
means the symlink is gone which prevents running mkosi from within
mkosi so let's recommend ~/.local/bin instead.
---

diff --git a/README.md b/README.md
index 1990dfdf3..3ff31bf3d 100644
--- a/README.md
+++ b/README.md
@@ -26,12 +26,13 @@ listed below instead.
 To run mkosi straight from its git repository, you can invoke the shim
 `bin/mkosi`. The `MKOSI_INTERPRETER` environment variable can be set
 when using the `bin/mkosi` shim to configure the python interpreter used
-to execute mkosi. The shim can be symlinked to e.g. `/usr/local/bin` to
-make it accessible from the `PATH`.
+to execute mkosi. The shim can be symlinked to e.g. `~/.local/bin` to
+make it accessible from the `PATH`. Note that to make this work you
+might have to add `~/.local/bin` to your user's `PATH`.
 
 ```shell
 git clone https://github.com/systemd/mkosi
-ln -s $PWD/mkosi/bin/mkosi /usr/local/bin/mkosi
+ln -s $PWD/mkosi/bin/mkosi ~/.local/bin/mkosi
 mkosi --version
 ```