Skip to content

Commit b269a80

Browse files
committed
Improve description for dev setup
Be more dogmatic in the setup to prevent confusion.
1 parent f43e666 commit b269a80

1 file changed

Lines changed: 17 additions & 23 deletions

File tree

src/bonsai/docs/guides/development/installation.rst

Lines changed: 17 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ that they are typically updated every day. To install the **Unstable** version:
8383
.. warning::
8484

8585
Make sure the extension you install has ``raw.githubusercontent.com`` as
86-
it's "Repository" (not ``extensions.blender.org``).
86+
the "Repository" (not ``extensions.blender.org``).
8787

8888
.. image:: images/unstable-repo.png
8989

@@ -143,29 +143,23 @@ and install.
143143
Live development environment
144144
----------------------------
145145

146-
One option for developers who want to actively develop from source is to follow
147-
the instructions from :ref:`guides/development/installation:Bundling for Blender`. However,
148-
creating a build, uninstalling the old add-on, and installing a new build is a
149-
slow process. Although it works, it is very slow, so we do not recommend it.
146+
First, install using the :ref:`guides/development/installation:Unstable
147+
installation` method. This will provide all compiled dependencies for you out
148+
of the box.
150149

151-
A more rapid approach is to follow the
152-
:ref:`guides/development/installation:Unstable installation` method, as this
153-
provides all dependencies for you out of the box.
154-
155-
Once you've done this, you can replace certain Python files that tend to be
156-
updated frequently with those from the Git repository. We're going to use
157-
symbolic links, so we can code in our Git repository, and see the changes in
158-
our Blender installation (you will need to restart Blender to see changes).
150+
Once you've done this, we'll replace the installed Python files with those from
151+
our Git repository. We're going to use symbolic links, so we can code in our
152+
Git repository, and see the changes in our Blender installation (you will need
153+
to restart Blender to see changes).
159154

160155
For Linux or Mac:
161156

162157
.. literalinclude:: ../../../scripts/installation/dev_environment.sh
163158
:language: bash
164159
:caption: dev_environment.sh
165160

166-
Or, if you're on Windows, you can use the batch script below. You need to run
167-
it as an administrator. Before running it follow the instructions descibed
168-
in the `rem` tags.
161+
For Windows, run this batch script as an administrator. Before running it
162+
follow the instructions descibed in the `rem` tags.
169163

170164
.. literalinclude:: ../../../scripts/installation/dev_environment.bat
171165
:language: bat
@@ -174,17 +168,17 @@ in the `rem` tags.
174168
After you modify your code in the Git repository, you will need to restart
175169
Blender for the changes to take effect.
176170

171+
Note that this only links Python code to the Git repository. If there are any
172+
major changes such as new dependencies or newly compiled C++ code, you will
173+
need to make the updates manually. This is relatively rare. Reviewing the
174+
`Makefile history
175+
<https://github.com/IfcOpenShell/IfcOpenShell/commits/v0.8.0/src/bonsai/Makefile>`__,
176+
is one quick way to see if a dependency has changed.
177+
177178
If there are changes to the IfcOpenShell binaries, you may replace the two
178179
``*ifcopenshell_wrapper*`` files with new ones downloaded from the automated
179180
`IfcOpenShell builds directory <https://builds.ifcopenshell.org/>`__.
180181

181-
The downside with this approach is that if a new dependency is added, or a
182-
compiled dependency has changed (that is not available via the build
183-
directory), or the build system changes, you'll need to fix your setup
184-
manually. But this is relatively rare. Reviewing the Makefile history, `here
185-
<https://github.com/IfcOpenShell/IfcOpenShell/commits/v0.8.0/src/bonsai/Makefile>`__,
186-
is one quick way to see if a dependency has changed.
187-
188182
.. seealso::
189183

190184
There is a `useful Blender Addon

0 commit comments

Comments
 (0)