From e142df3ae5df09d846c496629398d614096ef4d4 Mon Sep 17 00:00:00 2001 From: willGraham01 <1willgraham@gmail.com> Date: Wed, 31 Jan 2024 14:22:19 +0000 Subject: [PATCH] Mention citation tool in README --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2046e41..ae7dd9c 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,27 @@ # brainglobe-utils -Shared general purpose tools for the BrainGlobe project + +Shared general purpose tools for the BrainGlobe project, including [citation generation](#citations-for-brainglobe-tools). ## 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] ``` + +## Citations for BrainGlobe tools + +`brainglobe-utils` comes with the `cite-brainglobe` command line tool, to write citations for BrainGlobe tools for you so you don't need to worry about fetching the data yourself. +You can read about [how to use the tool](https://brainglobe.info/documentation/brainglobe-utils/citation-module.html) on the documentation website.