summaryrefslogtreecommitdiff
path: root/docs/dev/quickstart.rst
diff options
context:
space:
mode:
authorIvan Gabaldon <igabaldon@inetol.net>2025-10-01 06:29:07 +0200
committerGitHub <noreply@github.com>2025-10-01 06:29:07 +0200
commit41e0f2abf0546c3d27aa33d84e6220ea8bf257d0 (patch)
tree33bfbff64b2ffe9196479c65dc6263bab89a22a3 /docs/dev/quickstart.rst
parent0f3ef5da5959ee1bf69c5f357d7e8904193e3732 (diff)
[doc] dev - cleanup asdf remnants and add a note about mise-en-place (#5264)
Notes on the developer environment with MISE have been added to the Quickstart Guide. We migrated `.tool-versions` to replace it with `mise` [1], so we can now remove `asdf` related documentation. [1] https://github.com/searxng/searxng/pull/5253 Co-authored-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/dev/quickstart.rst')
-rw-r--r--docs/dev/quickstart.rst18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/dev/quickstart.rst b/docs/dev/quickstart.rst
index 973df3b2c..9fdee2e7b 100644
--- a/docs/dev/quickstart.rst
+++ b/docs/dev/quickstart.rst
@@ -23,6 +23,24 @@ Don't hesitate, just clone SearXNG's sources and start hacking right now ..
git clone https://github.com/searxng/searxng.git searxng
+For the developer environment, `mise en place`_ is recommended:
+
+.. code:: sh
+
+ $ curl https://mise.run | sh
+
+The tools required for a developer environment are provided via `mise.toml`_,
+trust the project:
+
+.. code:: sh
+
+ $ mise trust
+
+.. _mise.toml:
+ https://github.com/searxng/searxng/blob/master/mise.toml
+.. _mise en place:
+ https://mise.jdx.dev/getting-started.html
+
Here is how a minimal workflow looks like:
1. *start* hacking