Update docs/running-locally.md

Co-authored-by: Anton Gilgur <[email protected]> Signed-off-by: chengjoey <[email protected]>
argoproj · Sep 1, 2024 · 6594dbf · 6594dbf
1 parent d7d51a7
commit 6594dbf
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/.spelling b/.spelling
@@ -205,6 +205,7 @@ sandboxed
 shortcodes
 stateful
 stderr
+symlinks
 temporality
 triaged
 un-reconciled

diff --git a/docs/running-locally.md b/docs/running-locally.md
@@ -108,7 +108,9 @@ You can use the `TARGET_PLATFORM` environment variable to compile images for spe
 make argoexec-image TARGET_PLATFORM=linux/arm64,linux/amd64
 ```
 
-!!! Note "expected 'package', found signal..." If you see this error, you need to set git `core.symlinks=true`, just run `git config --global core.symlinks true` or `git -c core.symlinks=true clone`.
+!!! Note "Error `expected 'package', found signal_darwin`"
+    You may see this error if symlinks are not configured for your `git` installation.
+    Run `git config core.symlinks true` to correct this.
 
 To also start the API on <http://localhost:2746>: