Document serving requirements

This commit is contained in:
thePR0M3TH3AN
2025-06-17 22:31:44 -04:00
parent c6a0129193
commit 8fbed36797

View File

@@ -84,6 +84,10 @@ Additional documentation is available in the `src/` directory; see [src/README.m
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.
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.
## Batch Import
Place configuration files in an `imports/` directory at the project root. Run
@@ -111,4 +115,9 @@ include:
the files over Tor, allowing others to access them using the provided onion
address.
`index.html` fetches `config.json` dynamically, so the flyer should be viewed
through a local or remote web server. For quick testing, run
`python3 -m http.server` in the folder and open the provided address instead of
loading the file directly.
This project is licensed under the [MIT License](./LICENSE).