diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst index 3eb57db4c1dc4ba778bc37c54e97bdf3675f48b3..afdd7eb4183eef0786c7d87616d4979c204ff778 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 --------------------------