From 8298c05d50704259ba73ef052319d9ee8d4665a6 Mon Sep 17 00:00:00 2001 From: Josh Borrow Date: Wed, 3 Jul 2024 11:40:09 -0400 Subject: [PATCH] Add editable install info --- README.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.rst b/README.rst index 1e9edc66..2636f126 100644 --- a/README.rst +++ b/README.rst @@ -96,6 +96,14 @@ directory. We use the ``meson`` build system, which should be understood by We suggest you then test the installation by running the unit tests. You can do this by running ``pytest``. +To run an editable install, you will need to do so in a way that does not +have build isolation (as the backend build system, `meson` and `ninja`, actually +perform micro-builds on usage in this case): + +.. code-block:: console + + $ pip install --editable --no-build-isolation . + Contributions -------------