From 8fbed36797256802ac856b4b96ef52424d2800c6 Mon Sep 17 00:00:00 2001 From: thePR0M3TH3AN <53631862+PR0M3TH3AN@users.noreply.github.com> Date: Tue, 17 Jun 2025 22:31:44 -0400 Subject: [PATCH] Document serving requirements --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 2bcf127..4acfe0d 100644 --- a/README.md +++ b/README.md @@ -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/` 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).