Add note about version number

sherlock-project · May 18, 2024 · 07274a9 · 07274a9
1 parent 1b0e508
commit 07274a9
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/install.md b/docs/install.md
@@ -41,6 +41,8 @@ pipx install sherlock-project
 
 Building an editable (or live) package links the entry point to your current directory, rather than to the standard install location. This is often useful when working with the code base, as changes are reflected immediately without reinstallation.
 
+Note that the version number will be 0.0.0 for pipx local builds unless manually changed in the pyproject file (it will prompt the user for an update).
+
 ```bash
 # Assumes repository cloned, and pwd is repository root
 pipx install -e .