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

docs: explain download zip usage

Browse Source
This commit is contained in:
thePR0M3TH3AN
2025-06-21 11:19:17 -04:00
parent 1e8cd9c944
commit 379a62c78c
3 changed files with 15 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/usage.md
View File

@@ -5,7 +5,11 @@ This guide covers common CLI workflows. See `docs/docker.md` for Docker instruct
## Step-by-Step
1. Edit `src/index-master.html` or `src/nostr-master.html` if you need custom content.
2. Run `voxvera init` and follow the prompts, or use `voxvera init --from-pdf path/to/form.pdf`.
3. Host the generated `host/<subdomain>` directory. The `index.html` file fetches `config.json`, so the flyer must be served via a local or remote web server rather than opened directly from disk. For a quick test you can run `python3 -m http.server` inside the folder and then visit the provided address.
3. Build the flyer assets. Add an optional zip file at `src/download/download.zip` or pass `--download` to include it in the build:
```bash
voxvera build --download path/to/file.zip
```
4. Host the generated `host/<subdomain>` directory. The `index.html` file fetches `config.json`, so the flyer must be served via a local or remote web server rather than opened directly from disk. For a quick test you can run `python3 -m http.server` inside the folder and then visit the provided address. Visitors can use the **Download** button to retrieve the file.
## Batch Import
Place configuration files in an `imports/` directory at the project root and run: