thePR0M3TH3AN/VoxVera
1
0
Fork 0
mirror of https://github.com/PR0M3TH3AN/VoxVera.git synced 2025-09-08 06:58:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix README merge artifact and add quick steps

Browse Source
This commit is contained in:
thePR0M3TH3AN
2025-06-17 19:13:34 -04:00
parent 986944a56e
commit 0a85abb69d
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -1,5 +1,3 @@
// 🔧 merged conflicting changes from codex/create-readme.md-with-project-overview vs main
# VoxVera Flyers # 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. 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 # use answers from an existing PDF form
./src/create_flyer.sh --from-pdf path/to/form.pdf ./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/<subdomain>`. The contents in that directory can then be hosted. 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/<subdomain>`. 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. 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/<subdomain>` directory.
This project is licensed under the [MIT License](./LICENSE). This project is licensed under the [MIT License](./LICENSE).
```