genewildish/Mainline
1
0
Fork 1
Code Issues Pull Requests 4 Packages Projects Releases Wiki Activity

docs: Add ntfy.sh integration details, new CLI options, expanded configuration, and architecture overview to README. #11

Merged
genewildish merged 1 commits from docs/update-readme into main 2026-03-15 07:19:14 +00:00
Conversation 0 Commits 1 Files Changed 1 +77 -16
genewildish commented 2026-03-15 07:19:08 +00:00
Owner
Copy Link

docs: update README to reflect engine/ refactor and new features

The README was written against the old monolithic mainline.py. This brings it current with the feat/scalability refactor and the features introduced in feat/display.

Changes:
• Config — points to engine/config.py; adds all missing constants (SSAA, GRAD_SPEED, SCROLL_DUR, FRAME_DT, FIREHOSE_H, NTFY_*, FEED_TIMEOUT); fixes stale _-prefixed constant names
• Run — documents --firehose and --refresh flags; notes cache on subsequent runs
• How it works — adds SSAA, animated gradient sweep, and ntfy interrupt behavior
• Architecture — new section documenting the engine/ package layout and module boundaries
• Feeds — references engine/sources.py for FEEDS and POETRY_SOURCES
• ntfy.sh Integration — new section with push example and NtfyPoller reuse snippet
• Ideas/Future — removes "Animated gradient" (implemented); adds Extensibility subsection (serve.py, Rust port roadmap)

docs: update README to reflect engine/ refactor and new features The README was written against the old monolithic mainline.py. This brings it current with the feat/scalability refactor and the features introduced in feat/display. Changes: • Config — points to engine/config.py; adds all missing constants (SSAA, GRAD_SPEED, SCROLL_DUR, FRAME_DT, FIREHOSE_H, NTFY_*, FEED_TIMEOUT); fixes stale _-prefixed constant names • Run — documents --firehose and --refresh flags; notes cache on subsequent runs • How it works — adds SSAA, animated gradient sweep, and ntfy interrupt behavior • Architecture — new section documenting the engine/ package layout and module boundaries • Feeds — references engine/sources.py for FEEDS and POETRY_SOURCES • ntfy.sh Integration — new section with push example and NtfyPoller reuse snippet • Ideas/Future — removes "Animated gradient" (implemented); adds Extensibility subsection (serve.py, Rust port roadmap)
genewildish added 1 commit 2026-03-15 07:19:09 +00:00
docs: Add ntfy.sh integration details, new CLI options, expanded configuration, and architecture overview to README. 851c4a77b4
genewildish merged commit 47f17e12ef into main 2026-03-15 07:19:14 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
No items
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
genewildish
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: genewildish/Mainline#11
Delete Branch "docs/update-readme"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?