From 56dce03f34ab082409062e80aaa9b4f6b12f8b1a Mon Sep 17 00:00:00 2001 From: Iain Sproat <68657+iainsproat@users.noreply.github.com> Date: Fri, 4 Aug 2023 13:28:27 +0100 Subject: [PATCH] More README updates --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index de3ded8..3e07257 100644 --- a/README.md +++ b/README.md @@ -29,11 +29,15 @@ The comment is attributed to the user who registered the Function with Speckle A ## Developer Requirements - +1. Install the following: + - [Python 3](https://www.python.org/downloads/) + - [Poetry](https://python-poetry.org/docs/#installing-with-the-official-installer) +1. Run `poetry install` to install the required Python packages. ## Building and Testing - +The code can be tested locally by running `poetry run pytest`. +The code should also be packaged into the format required by Speckle Automate, a Docker Container Image, and that should also be tested. ## Resources