From 0d1ff1d707f7d344b3988feb0affdc303dfb19f2 Mon Sep 17 00:00:00 2001 From: Lars Noack Date: Wed, 23 Apr 2025 11:11:02 +0200 Subject: [PATCH] feat: installing instructions --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 04fb623..b118d36 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,21 @@ # Secure_pixelation -Hiding faces with Mosaic has proven incredibly unsafe especially with videos, because the algorythm isn't destructive. However, if you black out the selected area, repopulate it with generative ai, and then pixelate it, it should look authentic, but be 100% destructive, thus safe. \ No newline at end of file +Hiding faces with Mosaic has proven incredibly unsafe especially with videos, because the algorythm isn't destructive. However, if you black out the selected area, repopulate it with generative ai, and then pixelate it, it should look authentic, but be 100% destructive, thus safe. + +## Install + +1. create and activate a virtual env and activate it +2. install the local python program with pip +3. run `secure-pixelation` + +```bash +# Step 1: Create and activate virtual environment +python3 -m venv venv +source venv/bin/activate + +# Step 2: Install the local Python program add the -e flag for development +pip install . + +# Step 3: Run the secure-pixelation command +secure-pixelation +```