Skip to content

Commit 1e63a16

Browse files
Update installation instructions (#75)
1 parent 2f3ff1f commit 1e63a16

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ A [napari] plugin for registering images to a BrainGlobe atlas.
2121
## Usage
2222

2323
1. Open `napari`.
24-
2. Install the plugin with `pip install git+https://github.com/brainglobe/brainglobe-registration.git`.
24+
2. [Install the plugin](#Installation).
2525
3. Open the widget by selecting `Plugins > BrainGlobe Registration` in the napari menu bar near the
2626
top left of the window.
2727
![brainglobe-registration-plugin](./imgs/brainglobe_registration_plugin_window.png)
@@ -44,18 +44,20 @@ Select from one of the three provided default parameter sets (elastix, ARA, or I
4444
8. Click `Run` to register the image. The registered image will appear in the napari viewer.
4545
![brainglobe-registration-registered](./imgs/brainglobe_registration_registered.png)
4646
![brainglobe-registration-registered](./imgs/brainglobe_registration_registered_stacked.png)
47+
4748
## Installation
4849

4950
We strongly recommend to use a virtual environment manager (like `conda` or `venv`). The installation instructions below
5051
will not specify the Qt backend for napari, and you will therefore need to install that separately. Please see the
5152
[`napari` installation instructions](https://napari.org/stable/tutorials/fundamentals/installation.html) for further advice on this.
5253

53-
[WIP] You can install `brainglobe-registration` via [pip]:
54+
You can install `brainglobe-registration` via [pip]:
5455

5556
pip install brainglobe-registration
5657

58+
or [via napari](https://napari.org/stable/plugins/start_using_plugins/finding_and_installing_plugins.html).
5759

58-
To install latest development version :
60+
To install the latest development version :
5961

6062
pip install git+https://github.com/brainglobe/brainglobe-registration.git
6163

0 commit comments

Comments
 (0)