From 28f486f7025efad83122ae3042fdeb0655e41ecd Mon Sep 17 00:00:00 2001 From: Adina Wagner Date: Fri, 13 Sep 2024 14:32:08 +0200 Subject: [PATCH] docs: mention dl-next and its configuration as deps --- README.md | 8 +++++++- docs/source/settingup.rst | 8 ++++++++ 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4da6299..99df569 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ The development of this tool started at [OHBM Brainhack 2020](https://github.com ## Requirements -- Datalad: relies on [git-annex](http://docs.datalad.org/projects/osf/en/latest/git-annex.branchable.com/), [Git](http://docs.datalad.org/projects/osf/en/latest/git-scm.com/) and Python. If you don’t have DataLad installed yet, please follow the instructions [here](http://handbook.datalad.org/en/latest/intro/installation.html). +- Datalad and datalad-next: relies on [git-annex](http://docs.datalad.org/projects/osf/en/latest/git-annex.branchable.com/), [Git](http://docs.datalad.org/projects/osf/en/latest/git-scm.com/) and Python. If you don’t have DataLad installed yet, please follow the instructions [here](http://handbook.datalad.org/en/latest/intro/installation.html). - Account on the [Open Science Framework (OSF)](https://osf.io/register) ## Installation @@ -25,6 +25,12 @@ $ . ~/env/dl-osf/bin/activate $ pip install datalad-osf ``` +Afterwards, configure DataLad to load the ``datalad-next`` extension: + +``` +git config --global --add datalad.extensions.load next +``` + ## How to use See our [documentation](http://docs.datalad.org/projects/osf/) for more info on how to use this tool and a tutorial on major use cases. diff --git a/docs/source/settingup.rst b/docs/source/settingup.rst index 84fcb68..dc5360a 100644 --- a/docs/source/settingup.rst +++ b/docs/source/settingup.rst @@ -33,6 +33,14 @@ Installation # install from PyPi $ pip install datalad-osf. +Afterwards, configure DataLad to load the ``datalad-next`` extension: + +.. code-block:: bash + + $ git config --global --add datalad.extensions.load next + + + Getting started ^^^^^^^^^^^^^^^