From 0a85abb69dbd4b7cb24b5acf686866324cfbd266 Mon Sep 17 00:00:00 2001 From: thePR0M3TH3AN <53631862+PR0M3TH3AN@users.noreply.github.com> Date: Tue, 17 Jun 2025 19:13:34 -0400 Subject: [PATCH] Fix README merge artifact and add quick steps --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index fd7db08..8af63f8 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -// 🔧 merged conflicting changes from codex/create-readme.md-with-project-overview vs main - # VoxVera Flyers VoxVera provides scripts and templates for producing printable flyers with QR codes. These flyers link to content hosted through Tor and can also include a Nostr page. The project automates building the HTML, generating the QR codes, and copying all assets into a directory under `host/` so they can be served statically. @@ -21,12 +19,14 @@ Run the helper script from the repository root: # use answers from an existing PDF form ./src/create_flyer.sh --from-pdf path/to/form.pdf -```` +``` The script updates `src/config.json`, regenerates QR codes, obfuscates `index-master.html` and `nostr-master.html`, and copies the resulting files plus PDFs and QR images into `host/`. The contents in that directory can then be hosted. Additional documentation is available in the `src/` directory; see [src/README.md](src/README.md) for more details on the obfuscation scripts and additional usage notes. +## Step-by-Step +1. Edit `src/index-master.html` or `src/nostr-master.html` if you need custom content. +2. Run `./src/create_flyer.sh` and follow the prompts, or use `./src/create_flyer.sh --from-pdf path/to/form.pdf`. +3. Host the generated `host/` directory. This project is licensed under the [MIT License](./LICENSE). - -```