From 21962b21356f633427d7001337a1df1c5d816b3b Mon Sep 17 00:00:00 2001 From: thePR0M3TH3AN <53631862+PR0M3TH3AN@users.noreply.github.com> Date: Tue, 17 Jun 2025 19:01:58 -0400 Subject: [PATCH] Add project README --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..4652222 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# 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. + +## Prerequisites +- **Node.js** and **npm** +- **jq** +- **qrencode** +- **ImageMagick** (`convert`) +- **javascript-obfuscator** and **html-minifier-terser** (installed via npm) +- **pdftotext** (optional, used when extracting fields from a PDF form) + +## Generating a Flyer +Run the helper script from the repository root: + +```bash +# interactive prompts +./src/create_flyer.sh + +# 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. + +See [src/README.md](src/README.md) for more details on the obfuscation scripts and additional usage notes.