aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorAlex Schofield <git@ajschof.me>2025-02-17 14:32:05 +0000
committerAlex Schofield <git@ajschof.me>2025-02-17 14:32:05 +0000
commit00d940f72c4633855075cfb797732ef02588bba9 (patch)
treee5ccddee71d6f7907c0d396f57981f7d0a5fbfef /README.md
parent83569d8facffeedb325d63364dab91abe71ba3c6 (diff)
downloadgdpr-obfuscator-00d940f72c4633855075cfb797732ef02588bba9.tar.gz
gdpr-obfuscator-00d940f72c4633855075cfb797732ef02588bba9.zip
add setup/installation section
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
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
git.ajschof.me — hosted by ajschofield — powered by cgit