diff --git a/README.md b/README.md index cc24d3a2a38e44d7982c654a70b7d2d3acc311c9..f3526541b6e47690b0d4d5cf1b5e941206ef0a7c 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ This is an open-source project, licensed using [the MIT license](https://opensou For development and tests purpose it may be useful to install the project as a editable package with pip. - Use a virtualenv (e.g. with virtualenvwrapper `mkvirtualenv -a . dan`) +- Initialize the [`Nerval`](https://gitlab.teklia.com/ner/nerval) submodule (e.g. `git submodule update --init --recursive`) - Install `dan` as a package (e.g. `pip install -e .`) ### Linter diff --git a/docs/get_started/index.md b/docs/get_started/index.md index ddc34d0fad9aca53dba03f1abc732d6e13057585..90e88151d4bc0991179d4e8068660404c251b803 100644 --- a/docs/get_started/index.md +++ b/docs/get_started/index.md @@ -26,6 +26,12 @@ To install DAN manually, you need to first clone via: git clone git@gitlab.teklia.com:atr/dan.git ``` +Then you can initialize the [`Nerval`](https://gitlab.teklia.com/ner/nerval) submodule: + +```shell +git submodule update --init --recursive +``` + Then you can install it via pip: ```shell diff --git a/mkdocs.yml b/mkdocs.yml index 758964cef9c45bec8799828241470a9f196ca57a..3ac3aea259d4d272fc8975909b3f723d811cddef 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -144,7 +144,7 @@ extra: link: https://teklia.com - icon: fontawesome/brands/gitlab name: Git repository for this project - link: https://gitlab.com/teklia/atr/dan + link: https://gitlab.teklia.com/atr/dan - icon: fontawesome/brands/linkedin name: Teklia @ LinkedIn link: https://www.linkedin.com/company/teklia