Merge pull request #203 from datalad/next

docs: mention dl-next and its configuration as deps
datalad · Sep 13, 2024 · 5f76d5d · 5f76d5d
2 parents d8e9355 + 28f486f
commit 5f76d5d
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git 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
@@ -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
 ^^^^^^^^^^^^^^^