cottongin/pi-weekly-newspaper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Compare commits

base: cottongin:0abfe179142d3264ffd76b58fd41291d3e22c7ea
Branches Tags
cottongin:master
...
compare: cottongin:7339e8c0d679d74a757ffd89f88c49626f31a530
Branches Tags
cottongin:master

2 Commits
0abfe17914 ... 7339e8c0d6

Author SHA1 Message Date
cottongin
7339e8c0d6 docs: use htmlpreview for gallery links in README 
- Replaced local links to docs/gallery.html with htmlpreview.github.io links
- Allows the interactive gallery to be viewed directly from the GitHub repository

Made-with: Cursor
 2026-04-07 15:32:22 -04:00
cottongin
202b2c8b35 chore: tweak README 2026-04-07 15:24:37 -04:00
1 changed files with 5 additions and 11 deletions
Expand all files Collapse all files

16
README.md
View File

@@ -1,16 +1,10 @@
# PI Weekly Newspaper
[![Application Preview](docs/screenshots/mosaic_small.png)](docs/gallery.html)
[![Application Preview](docs/screenshots/mosaic_small.png)](https://htmlpreview.github.io/?https://github.com/cottongin/pi-weekly-newspaper/blob/master/docs/gallery.html)
Generates weekly ePub "newspapers" from the [Plymouth Independent](https://www.plymouthindependent.org/) RSS feed, optimized for the Xtreink X4 e-reader (800x480 screen).
[📸 View all screenshots](docs/screenshots.md) | [🖼️ View Interactive Gallery](docs/gallery.html)
## Screenshots & Gallery
- **[Interactive HTML Gallery](docs/gallery.html)** - A slide deck view of the app's features.
- **[Markdown Screenshots List](docs/screenshots.md)** - A full page showing all screenshots with descriptions.
- **[Large Mosaic](docs/screenshots/mosaic_large.png)** - A high-resolution 4x2 grid of all screenshots (great for sharing).
[📸 View all screenshots](docs/screenshots.md) | [🖼️ View Interactive Gallery](https://htmlpreview.github.io/?https://github.com/cottongin/pi-weekly-newspaper/blob/master/docs/gallery.html) | [🪟 Large Mosaic](docs/screenshots/mosaic_large.png)
## Quick Start
@@ -28,7 +22,7 @@ Open http://localhost:5000 in your browser.
- **Periodic RSS fetching** with configurable interval
- **Automatic image processing** — downloads, resizes to e-reader constraints, converts to baseline JPEG
- **ePub generation** with articles as chapters, table of contents, and embedded images
- **AI-generated covers** via Pollinations.ai (free, no API key) with text fallback
- **Auto-generated covers** Mosaic art formed with each week's article's featured images, with text fallback
- **Web UI** accessible from any device on your network
- **Scheduled or manual publishing**
@@ -36,7 +30,7 @@ Open http://localhost:5000 in your browser.
1. Click **Fetch Now** on the dashboard to pull articles
2. Go to **Publish**, select the target week, toggle articles on/off
3. Choose a cover method (AI or Text) and click **Generate Issue**
3. Choose a cover method (Mosaic or Text) and click **Generate Issue**
4. Download the `.epub` from the **Issues** archive
## Configuration
@@ -62,4 +56,4 @@ GRIMMORY_LIBRARY_ID=optional_library_id
## Access from Other Devices
The app binds to `0.0.0.0:5000`, so access it from any device on your network using your Mac's IP address (e.g., `http://192.168.1.x:5000`).
The app binds to `0.0.0.0:5000`, so access it from any device on your network using the server's IP address (e.g., `http://192.168.1.x:5000`).