From cdf218785ddc18e071c4ee0d5beb48d8ed8a09ca Mon Sep 17 00:00:00 2001
From: Erik Reid <erik.reid@geant.org>
Date: Wed, 22 Mar 2023 19:02:03 +0100
Subject: [PATCH] added some local setup instructions

---
 docs/source/quickstart.rst | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst
index 3eb57db..afdd7eb 100644
--- a/docs/source/quickstart.rst
+++ b/docs/source/quickstart.rst
@@ -9,6 +9,35 @@ Quick Start
 *This is a quick setup guide for running
 standalone on your local machine*
 
+Install the Module
+--------------------
+
+*one of these should be what you're looking for:*
+
+* just install the latest module snapshot
+
+.. code-block::
+
+    python3 -m venv my-venv-directory
+    . my-venv-directory/bin/activate
+
+    pip install --pre --extra-index-url https://artifactory.software.geant.org/artifactory/api/pypi/geant-swd-pypi/simple nat-resource-manager
+
+* install the source code
+
+.. code-block::
+
+    python3 -m venv my-venv-directory
+    . my-venv-directory/bin/activate
+
+    git clone https://gitlab.geant.org/goat/resource-management.git
+    cd resource-management
+    pip install -e .
+
+    # for a full dev environment
+    pip install -r requirements.txt
+
+
 Create a Local Database
 --------------------------
 
-- 
GitLab