Skip to content

Commit b41b3a4

Browse files
juney-leegitbook-bot
authored andcommitted
GITBOOK-71: tidying up getting started
1 parent 2150256 commit b41b3a4

File tree

1 file changed

+24
-21
lines changed

1 file changed

+24
-21
lines changed

gitbook/introduction/getting-started.md

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,61 @@
11
# Getting Started
22

3-
COMPAS RhinoVAULT is a plugin for Rhino 8 and uses the new CPython runtime. It can be installed using Yak, Rhino's package manager.
4-
5-
{% hint style="warning" %}
6-
COMPAS Masonry is **only available for Rhino 8.**
7-
{% endhint %}
3+
RhinoVAULT is a plugin for Rhino 8 and uses the new CPython runtime. It can be installed using Yak, Rhino's package manager. This page will guide you through the installation process for RhinoVAULT.
84

95
***
106

117
## Requirements
128

9+
The following are the prerequisites for installing RhinoVAULT.
10+
1311
* [Rhino 8](https://www.rhino3d.com/)
12+
* Windows 10 or above / macOS 12 or above
13+
14+
In case you do not possess [Rhino](https://www.rhino3d.com/), download a fully featured, free trial version.
15+
16+
{% hint style="warning" %}
17+
RhinoVAULTLT is available for Rhino 8 **only.**
18+
{% endhint %}
1419

1520
***
1621

17-
## Installation
22+
## 1. Installation
1823

19-
* Start Rhino 8 and launch Yak by typing `PackageManager` on the Rhino command line.
20-
* Search the online packages for "RhinoVAULT".
21-
* Select "COMPAS RhinoVAULT" from the list.
22-
* Install.
24+
1. Start Rhino 8 and launch Yak by typing `PackageManager` in the Rhino command line.
25+
2. Search the online packages for "RhinoVAULT".
26+
3. Select "COMPAS RhinoVAULT" from the list.
27+
4. Make sure the latest version is selected, then click Install.
2328

2429
<figure><img src="../.gitbook/assets/RV_package-manager.png" alt=""><figcaption><p>Rhino package manager</p></figcaption></figure>
2530

2631
***
2732

33+
## 2. RhinoVAULT Toolbar
34+
2835
After the installation, you should see the RhinoVAULT toolbar in the Rhino workspace.&#x20;
2936

3037
<figure><img src="../.gitbook/assets/RV_toolbar (1).png" alt=""><figcaption><p>RhinoVAULT toolbar</p></figcaption></figure>
3138

32-
If the toolbar is not visible after installing RhinoVAULT, you can load it from the "Toolbars" page. To open the "Toolbars" page, type `Toolbars` on the Rhino command line.
39+
If the toolbar is not visible after installing RhinoVAULT, you can load it from the "Toolbars" tab in Rhino options. To open the "Toolbars" page, type `Toolbars` on the Rhino command line.
3340

34-
<figure><img src="../.gitbook/assets/RV_toolbar-install.png" alt=""><figcaption><p>Load the toolbar using the "Toolbars" page.</p></figcaption></figure>
41+
<figure><img src="../.gitbook/assets/RV_toolbar-install.png" alt=""><figcaption><p>Load the toolbar using the "Toolbars" tab in Rhino options.</p></figcaption></figure>
3542

3643
***
3744

38-
## Check the Installation
39-
40-
To check the installation, simply press the left-most button on the toolbar, or run the `RV` in the Rhino command prompt. This will install any missing COMPAS packages and display a "Splash" screen when the installation is completed. Close the screen by agreeing to the [legal terms](../additional-information/legal-terms.md) of using COMPAS-RhinoVAULT.
45+
## 3. Check the Installation
4146

42-
<figure><img src="../.gitbook/assets/RV_splash-window.png" alt=""><figcaption><p>RhinoVAULT splash screen</p></figcaption></figure>
47+
To check the installation, simply press the left-most button on the toolbar, or run the command `RV` in the Rhino command prompt. A splash screen will pop up, where you will need to read and agree to the [legal terms](../additional-information/legal-terms.md) of using RhinoVAULT.
4348

44-
RhinoVAULT uses the following COMPAS packages. After installing RhinoVAULT with Yak, these requirements will be installed automatically if they are not yet available. Note that the tool ,ight be unresponsive for a few seconds while this happens. The packages are installed in a separate virtual environment named `rhinovault`.
49+
RhinoVAULT uses the following COMPAS packages, which will be installed automatically when `RV` command is triggered, if they are not yet available. The packages are installed in a separate virtual environment named `rhinovault`.
4550

4651
* [compas](https://github.com/compas-dev/compas)
4752
* [compas\_fd](https://github.com/blockresearchgroup/compas\_fd)
4853
* [compas\_rui](https://github.com/blockresearchgroup/compas\_rui)
4954
* [compas\_session](https://github.com/blockresearchgroup/compas\_session)
5055
* [compas\_tna](https://github.com/blockresearchgroup/compas\_dr)
5156

57+
<figure><img src="../.gitbook/assets/RV_splash-window.png" alt=""><figcaption><p>RhinoVAULT splash screen</p></figcaption></figure>
58+
5259
{% hint style="info" %}
5360
Note that installing the packages (and the dependencies of the packages) may take some time, so don't worry if the the dialog doesn't pop up immediately. Be patient!
5461
{% endhint %}
55-
56-
***
57-
58-
##

0 commit comments

Comments
 (0)