From 6915aac0923b3877ef5f45d0151d5567d5f510af Mon Sep 17 00:00:00 2001 From: n8fr8 Date: Wed, 15 Apr 2026 09:09:53 -0400 Subject: [PATCH] update with build script to configure base path and generate files dynamically --- README.md | 51 ++++- build.sh | 189 ++++++++++++++++++ index.html | 14 +- podcast.xml | 16 +- .../2022-02-17-more-discussions-on-ipfs.md | 0 ...ghts-and-privacy-preserving-measurement.md | 0 .../2024-02-09-Indigenous-Caravan.md | 0 .../ProofModeCaravan-English-Feb2024.mp3 | Bin .../cleaninsightsoverviewmarch2023.mp3 | Bin .../news-on-the-dweb.mp3 | Bin 10 files changed, 250 insertions(+), 20 deletions(-) create mode 100755 build.sh rename 2022-02-17-more-discussions-on-ipfs.md => posts/2022-02-17-more-discussions-on-ipfs.md (100%) rename 2023-03-22-cleaninsights-and-privacy-preserving-measurement.md => posts/2023-03-22-cleaninsights-and-privacy-preserving-measurement.md (100%) rename 2024-02-09-Indigenous-Caravan.md => posts/2024-02-09-Indigenous-Caravan.md (100%) rename ProofModeCaravan-English-Feb2024.mp3 => posts/ProofModeCaravan-English-Feb2024.mp3 (100%) rename cleaninsightsoverviewmarch2023.mp3 => posts/cleaninsightsoverviewmarch2023.mp3 (100%) rename news-on-the-dweb.mp3 => posts/news-on-the-dweb.mp3 (100%) diff --git a/README.md b/README.md index 6fc09e7..cc8496e 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,61 @@ # ButterBox Content Pack Sample Podcast -A small, self-contained sample podcast webpage and RSS feed from [Guardian Project](https://guardianproject.info). This repository is intended as an example "content pack" — a minimal, portable bundle of everything needed to host and distribute a podcast: episode audio, show notes, a landing page, and a standards-compliant feed. +A small, self-contained sample podcast webpage and RSS feed from [Guardian Project](https://guardianproject.info). This repository is intended as an example "content pack": a minimal, portable bundle of everything needed to host and distribute a podcast, including episode audio, show notes, a landing page, and a standards-compliant feed. ## What's inside - **`index.html`** : A simple, styled landing page that lists each episode with inline audio playback. - **`podcast.xml`** : An RSS 2.0 feed with iTunes podcast extensions, suitable for submission to podcast directories and use in podcast players. -- **`*.mp3`** : The three episode audio files. -- **`*.md`** : Per-episode show notes in Markdown. +- **`posts/*.md`** : Per-episode show notes in Markdown (YAML frontmatter holds the episode metadata). +- **`posts/*.mp3`** : The episode audio files, colocated with their show notes. +- **`build.sh`** : Regenerates `index.html` and `podcast.xml` from the contents of `posts/`. ## Using it -Because everything is relative-linked, you can serve this site from a folder on a USB drive plugged into a ButterBox device. +Because everything in `index.html` is relative-linked, you can serve this site from a folder on a USB drive plugged into a ButterBox device. To subscribe in a podcast client, point it at the hosted URL of `podcast.xml`. +## Building `index.html` and `podcast.xml` + +Both output files are generated from the markdown posts in `posts/` by `build.sh`. Run the script any time you add, remove, or edit a post: + +```sh +./build.sh +``` + +The single required argument is the **absolute URL prefix where the mp3 files will be served**. It is only used for the `` entries in `podcast.xml`, because RSS enclosures must be absolute URLs so podcast clients can download them without knowing where the feed lives. Everything else in the generated files (the RSS ``, the `