added installation instructions to README

brainglobe · Nov 10, 2023 · 8523d34 · 8523d34
1 parent 5869c79
commit 8523d34
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,18 @@
 # brainglobe-utils
 Shared general purpose tools for the BrainGlobe project
+
+## Installation
+
+```bash
+pip install brainglobe-utils
+```
+To also include the dependencies required for `napari`, use:
+```bash
+pip install brainglobe-utils[napari]
+```
+
+For development, clone this repository and install the dependencies with one of the following commands:
+```bash
+pip install -e .[dev]
+pip install -e .[dev,napari]
+```