DOC: add direnv and .envrc instructions

ComPWA · Aug 1, 2024 · 752335c · 752335c
1 parent b0885ba
commit 752335c
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/.cspell.json b/.cspell.json
@@ -69,6 +69,7 @@
     "Dalitz",
     "deadsnakes",
     "defaultdict",
+    "direnv",
     "dummifies",
     "dummify",
     "eigenstates",
@@ -204,6 +205,7 @@
     "einsum",
     "elif",
     "endswith",
+    "envrc",
     "epsabs",
     "epsrel",
     "eqnarray",

diff --git a/docs/develop.md b/docs/develop.md
@@ -137,6 +137,10 @@ uv pip install -e .
 :::
 ::::
 
+:::{tip}
+[Install `direnv`](https://direnv.net/docs/installation.html) if a repository contains a {file}`.envrc` file. This ensures that the appropriate environment is activates once you navigate into the repository!
+:::
+
 ### Editable installation
 
 When developing a package, it is most convenient if you install it in