Compare commits

..

4 Commits

Author SHA1 Message Date
cottongin
a605024024 chore: add AI warning to README 2026-04-07 15:44:24 -04:00
cottongin
3d36517511 docs: fix gallery and repo URLs
- Updated README.md to use the correct htmlpreview URL for Gitea
- Updated docs/gallery.html 'Back to README' link to point to the main repo URL

Made-with: Cursor
2026-04-07 15:37:25 -04:00
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
2 changed files with 9 additions and 12 deletions

View File

@@ -1,16 +1,13 @@
> [!IMPORTANT]
> This project was developed entirely with AI coding assistance (Google Gemini 3.1 Pro, via Cursor IDE) and has not undergone rigorous review. It is provided as-is and may require adjustments for other environments.
# PI Weekly Newspaper # 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://code.cottongin.xyz/cottongin/pi-weekly-newspaper/raw/branch/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). 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) [📸 View all screenshots](docs/screenshots.md) | [🖼️ View Interactive Gallery](https://htmlpreview.github.io/?https://code.cottongin.xyz/cottongin/pi-weekly-newspaper/raw/branch/master/docs/gallery.html) | [🪟 Large Mosaic](docs/screenshots/mosaic_large.png)
## 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).
## Quick Start ## Quick Start
@@ -28,7 +25,7 @@ Open http://localhost:5000 in your browser.
- **Periodic RSS fetching** with configurable interval - **Periodic RSS fetching** with configurable interval
- **Automatic image processing** — downloads, resizes to e-reader constraints, converts to baseline JPEG - **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 - **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 - **Web UI** accessible from any device on your network
- **Scheduled or manual publishing** - **Scheduled or manual publishing**
@@ -36,7 +33,7 @@ Open http://localhost:5000 in your browser.
1. Click **Fetch Now** on the dashboard to pull articles 1. Click **Fetch Now** on the dashboard to pull articles
2. Go to **Publish**, select the target week, toggle articles on/off 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 4. Download the `.epub` from the **Issues** archive
## Configuration ## Configuration
@@ -62,4 +59,4 @@ GRIMMORY_LIBRARY_ID=optional_library_id
## Access from Other Devices ## 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`).

View File

@@ -180,7 +180,7 @@
<img src="screenshots/08-settings.png" class="thumb" onclick="setSlide(7)"> <img src="screenshots/08-settings.png" class="thumb" onclick="setSlide(7)">
</div> </div>
<a href="../README.md" class="back-link">&larr; Back to README</a> <a href="https://code.cottongin.xyz/cottongin/pi-weekly-newspaper" class="back-link">&larr; Back to README</a>
<script> <script>
let currentSlide = 0; let currentSlide = 0;