From f2a816e33b49e75d6e5f527ab77b2ca5699ff348 Mon Sep 17 00:00:00 2001 From: moshferatu Date: Tue, 10 Dec 2024 19:21:00 -0800 Subject: [PATCH] Add local workspace setup instructions to strategies module documentation --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 4cdd5e4..f877abb 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,17 @@ # Strategies +## Local Workspace Setup + +After checking out the repository, the dependencies can be installed as follows (ideally in a virtual environment): + +```shell +pip install . --extra-index-url https://moshferatu.dev/api/packages/moshferatu/pypi/simple +``` + +If you want the build and test dependencies as well: + +```shell +pip install .[build,test] --extra-index-url https://moshferatu.dev/api/packages/moshferatu/pypi/simple +``` + --- \ No newline at end of file