From 46b20133fc88dbe91804f643a95c47c1d89d1302 Mon Sep 17 00:00:00 2001 From: Mihaela Duta Date: Thu, 28 Nov 2024 13:47:37 +0000 Subject: [PATCH] Update documentation. --- README.md | 6 ++++++ docs/source/intro.rst | 8 +++++++- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2a59c7f..5a3e20b 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,12 @@ Setup the virtual environment pip install '.[docs]' ``` +4. To install the development dependencies + + ```shell + pip install '.[dev]' + ``` + ## License ## Contributors diff --git a/docs/source/intro.rst b/docs/source/intro.rst index 07e063c..74a370a 100644 --- a/docs/source/intro.rst +++ b/docs/source/intro.rst @@ -12,7 +12,7 @@ Clone the repository on your machine .. code-block:: bash - git clone https://github.com/lotzma/L2Gv2.git + git clone https://github.com/OxfordRSE/L2Gv2.git Setup the virtual environment @@ -42,6 +42,12 @@ Setup the virtual environment pip install '.[tests]' pip install '.[docs]' +4. To install the development dependencies + + .. code-block:: bash + + pip install '.[dev]' + .. _pytorch-geometric: https://pypi.org/project/torch-geometric/ GitHub actions & pre-commit integration