restructure installation instructions to clone first

bihealth · Jan 15, 2025 · 669b2c8 · 669b2c8
1 parent 513f7b2
commit 669b2c8
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -9,17 +9,12 @@ Tooling for connecting GitLab, pipelines, and SODAR at CUBI.
 
 ## Getting Started
 
-Prerequisites when using conda:
+Clone CUBI-TK, create a conda environment (containing `hashdeep`) and install using [`uv`](https://docs.astral.sh/uv/).
 
 ```bash
+$ git clone [email protected]:bihealth/cubi-tk.git
 $ conda env create -n cubi-tk -f environment.yaml
 $ conda activate cubi-tk
-```
-
-Clone CUBI-TK and install.
-
-```bash
-$ git clone [email protected]:bihealth/cubi-tk.git
 $ cd cubi-tk
 $ uv python pin 3.12
 $ uv sync

diff --git a/docs_manual/installation.rst b/docs_manual/installation.rst
@@ -4,18 +4,13 @@
 Installation
 ============
 
-Prerequisites when using conda:
+Clone CUBI-TK, create a conda environment (containing `hashdeep`) and install using [`uv`](https://docs.astral.sh/uv/).
 
 .. code-block:: bash
 
+  $ git clone [email protected]:bihealth/cubi-tk.git
   $ conda env create -n cubi-tk -f environment.yaml
   $ conda activate cubi-tk
-
-Clone CUBI-TK and install:
-
-.. code-block:: bash
-
-  $ git clone [email protected]:bihealth/cubi-tk.git
   $ cd cubi-tk
   $ uv python pin 3.12
   $ uv sync