Add dev install instructins to official docs

This commit is contained in:
Dion Moult
2024-09-01 13:23:31 +10:00
parent f2554bc968
commit 90f9ebd25e
8 changed files with 88 additions and 20 deletions
Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

@@ -9,6 +9,7 @@ This chapter covers how you can help contribute to Bonsai.
:hidden:
:maxdepth: 2
installation
hello_world
running_tests
translations
@@ -3,20 +3,16 @@ Installation
There are different methods of installation, depending on your situation.
1. **Unstable installation** is recommended for power users helping with testing.
2. **Bundling for Blender** is recommended for distributing the add-on.
3. **Live development environment** is recommended for developers who are actively coding.
4. **Packaged installation** is recommended for those who use a package manager.
1. :ref:`guides/development/installation:Unstable installation` is recommended
for power users helping with testing.
2. :ref:`guides/development/installation:Bundling for blender` is recommended for distributing the add-on.
3. :ref:`guides/development/installation:Live development environment` is
recommended for developers who are actively coding.
4. :ref:`guides/development/installation:Packaged installation` is recommended
for those who use a package manager.
Unstable installation
---------------------
**Unstable installation** is almost the same as **Stable installation**, except
that they are typically updated every day. Simply download a daily build from
the `GitHub releases page
<https://github.com/IfcOpenShell/IfcOpenShell/releases?q=bonsai&expanded=true>`__,
then follow the usual :doc:`installation
instructions</users/quickstart/installation>`.
System requirements
-------------------
Bonsai officially supports all major 64-bit platforms, as well as the Python
version shipped by the Blender Foundation for the most recent three major
@@ -41,6 +37,76 @@ Other system specifications match the `Blender Requirements
Sometimes, a build may be delayed, or contain broken code. We try to avoid this,
but it happens.
Unstable installation
---------------------
**Unstable installation** is almost the same as **Stable installation**, except
that they are typically updated every day. To install the **Unstable** version:
1. Open up Blender, and click on ``Edit > Preferences``.
.. image:: /quickstart/images/install-bonsai-1.png
2. Select the **Get Extensions** tab, and press **Allow Online Access**.
.. image:: /quickstart/images/install-bonsai-2.png
3. Go to the `Bonsai Unstable Repository
<https://github.com/IfcOpenShell/bonsai_unstable_repo>`__, and drag and drop
from the appropriate link in the ``ID`` column of the table into Blender
depending on your operating system.
.. image:: images/unstable-drag-drop.png
4. Enable **Check for Updates on Startup** to get updates for daily Bonsai
builds automatically.
.. image:: images/unstable-auto-update.png
.. tip::
Instead of drag and drop, you can manually create the repository:
Open :menuselection:`Topbar --> Edit --> Preferences --> Get Extensions
--> Repositories (Top Right) --> "+" Icon --> Add Remote Remository`.
You'll see a window similar to the one above.
Use as URL:
``https://raw.githubusercontent.com/IfcOpenShell/bonsai_unstable_repo/main/index.json``
and enable **Check for Updates on Startup** if you want them.
5. Search for **Bonsai** in the top left search bar, then press the **Install**
button.
.. image:: /quickstart/images/install-bonsai-3.png
.. warning::
Make sure the extension you install has ``raw.githubusercontent.com`` as
it's "Repository" (not ``extensions.blender.org``).
.. image:: images/unstable-repo.png
6. Whenever a new update is available, you'll see it in the bottom right
:menuselection:`Status Bar`
.. image:: images/unstable-icon.png
7. To update, click on the update button in :menuselection:`Topbar --> Edit -->
Preferences --> Get Extensions`.
.. image:: /guides/images/update.png
8. After an update, be sure to restart.
.. image:: images/unstable-restart.png
If you wish to install an **Unstable** version offline, you can download a
daily build from the `GitHub releases page
<https://github.com/IfcOpenShell/IfcOpenShell/releases?q=bonsai&expanded=true>`__,
then go to :menuselection:`Topbar --> Edit --> Preferences --> Get Extensions
--> "V" Icon (top right) --> Install from Disk`.
Bundling for Blender
--------------------
@@ -72,12 +138,13 @@ Live development environment
----------------------------
One option for developers who want to actively develop from source is to follow
the instructions from :ref:`devs/installation:Bundling for Blender`. However,
the instructions from :ref:`guides/development/installation:Bundling for Blender`. However,
creating a build, uninstalling the old add-on, and installing a new build is a
slow process. Although it works, it is very slow, so we do not recommend it.
A more rapid approach is to follow the :ref:`devs/installation:Unstable
installation` method, as this provides all dependencies for you out of the box.
A more rapid approach is to follow the
:ref:`guides/development/installation:Unstable installation` method, as this
provides all dependencies for you out of the box.
Once you've done this, you can replace certain Python files that tend to be
updated frequently with those from the Git repository. We're going to use
+4 -4
View File
@@ -30,13 +30,13 @@ Updating
We always recommend to use the latest version.
Open up Blender, click on ``Edit > Preferences``, and select the **Get
Extensions** tab. If an update is available, you will see a button next to the
Open up Blender, click on :menuselection:`Topbar --> Edit --> Preferences -->
Get Extensions`. If an update is available, you will see a button next to the
**Bonsai** add-on.
Updates are typically available every 2 months. If you need something more
frequent, check out :ref:`devs/installation:unstable installation` which is
updated every day.
frequent, check out :ref:`guides/development/installation:Unstable
installation` which is updated every day.
.. image:: images/update.png