From 00d940f72c4633855075cfb797732ef02588bba9 Mon Sep 17 00:00:00 2001 From: Alex Schofield Date: Mon, 17 Feb 2025 14:32:05 +0000 Subject: add setup/installation section --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 113d841..225a999 100644 --- a/README.md +++ b/README.md @@ -35,4 +35,22 @@ This meets the requirements under the General Data Protection Regulation [(GDPR) - Python >= 3.13 - Poetry >= 2.0.1 +### Installation + +1. Clone the repository: + +``` +git clone --recurse-submodules https://github.com/ajschofield/gdpr-obfuscator.git +cd gdpr-obfuscator +``` + +2. Install dependencies using poetry + +``` +# Production +poetry install +# Developer (optional) +poetry install --dev +``` + ## Usage -- cgit v1.2.3