diff --git a/CHANGELOG.md b/CHANGELOG.md index b6834f8..b191bd6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,6 +15,7 @@ - Consolidated engineering guidance into contributing docs and App Store packaging into release docs. - Documented that vibe coded pull requests are welcome when they include clear change documentation, strict QA, and UI screenshots or recordings when relevant. - Documented `https://www.akkolli.net/ihatepdfs` as the project website and `akshaykolli@hotmail.com` as the support contact. +- Clarified that the project is vibe coded and maintained with AI agents, and that feature requests and agent-assisted PRs are welcome under the QA guidelines. ## Version 0.4.0 (build 6) - 2026-06-25 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0c82285..03788ce 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ I Hate PDFs is a native macOS app for local PDF reading and annotation. Contribu By contributing, you agree that your contribution is licensed under GNU General Public License version 2 only. -Vibe coded pull requests are welcome. This is a vibe coded repo, but vibe coded does not mean unreviewed: every change must be understandable, documented, tested at the right level, and held to the same strict QA bar as hand-written code. +This project is vibe coded and maintained with AI agents. Feature requests are welcome; the maintainer will get to them as time allows. Agent-assisted pull requests are welcome too, but vibe coded does not mean unreviewed: every change must be understandable, documented, tested at the right level, and held to the same strict QA bar as hand-written code. ## Before You Start diff --git a/README.md b/README.md index 98020ea..90d8251 100644 --- a/README.md +++ b/README.md @@ -52,24 +52,14 @@ The direct-download DMG is separate from the Mac App Store build. The App Store ## Features -- Open local `.pdf` files from disk. -- Drag a PDF onto the empty app window to open it. -- Read with smooth PDFKit scrolling, Retina rendering, zoom, fit-to-width, fit-to-page, and page navigation. -- Search selectable text PDFs from a compact toolbar control. -- Start each opened PDF in a focused single-pane reading layout, with the document fit to the available width and sidebars hidden until requested. -- Adapt the reader layout across compact, regular, and wide Mac windows while preserving usable PDF width. -- Configure highlight and comment colors, including opacity, from Settings. -- Reopen recent PDFs from the empty window or File > Open Recent. -- Close the current PDF back to the empty window without closing the app window. -- Create standalone highlights from selected text. -- Create selected-text comments and underline comments. -- Create free-text annotations directly on the page. -- Press Return to save comments and replies, or Shift-Return for a new line. -- Click commented or underlined text in the PDF to reopen and edit the comment in place. -- Save annotations directly into the original PDF after an overwrite warning. -- Save As a new annotated copy. -- Share the annotated PDF through the native macOS share picker. -- Review annotations in a comments sidebar with page grouping, search, filters, replies, edit/delete, and click-to-navigate. +- Incredibly small app size: v0.4 ships as a 957 KB direct-download DMG, with a 253 KB Apple Silicon archive and a 287 KB Intel archive. +- Extremely fast native PDF reading: built on SwiftUI, AppKit, and PDFKit instead of a bundled browser, runtime, database, or PDF engine. +- Power- and size-efficient by design: minimal assets, no bundled services, and no background sync workload. +- Local-first privacy: opens user-selected PDFs from disk and does not require accounts, analytics, tracking, or cloud upload. +- No internet auto-updater: releases are explicit downloads, so the app is not running update checks in the background. +- No AI features: no summaries, remote prompts, embeddings, model downloads, or document analysis. +- Clean review system: focused highlighting, commenting, replies, bookmarks, search, and sidebars that stay hidden until needed. +- Standards-compatible annotations: comments and highlights are written back into PDFs so they remain useful in common PDF readers. ## Privacy And Support @@ -159,6 +149,7 @@ Open source contribution policy: - Contributions are accepted under GPL-2.0-only. See [LICENSE](LICENSE). - Vibe coded pull requests are welcome, but they must include clear change documentation, strict QA notes, and screenshots or recordings for UI changes. +- This project is vibe coded and maintained with AI agents. Feature requests are welcome, and agent-assisted PRs are welcome when they follow the QA and contribution guidelines. - Start with [CONTRIBUTING.md](CONTRIBUTING.md) before opening a pull request. - UI pull requests must include before/after screenshots or a short screen recording. - Screenshots, recordings, and committed media files included with a pull request must each be under 1 MB. diff --git a/docs/screenshots/default-reading.png b/docs/screenshots/default-reading.png index 8cc9b30..4046a03 100644 Binary files a/docs/screenshots/default-reading.png and b/docs/screenshots/default-reading.png differ diff --git a/docs/screenshots/rust-book-01.png b/docs/screenshots/rust-book-01.png new file mode 100644 index 0000000..6d3a0ad Binary files /dev/null and b/docs/screenshots/rust-book-01.png differ diff --git a/docs/screenshots/rust-book-02.png b/docs/screenshots/rust-book-02.png new file mode 100644 index 0000000..dc112f1 Binary files /dev/null and b/docs/screenshots/rust-book-02.png differ diff --git a/docs/screenshots/rust-book-03.png b/docs/screenshots/rust-book-03.png new file mode 100644 index 0000000..3bcd989 Binary files /dev/null and b/docs/screenshots/rust-book-03.png differ diff --git a/docs/screenshots/rust-book-04.png b/docs/screenshots/rust-book-04.png new file mode 100644 index 0000000..d63773f Binary files /dev/null and b/docs/screenshots/rust-book-04.png differ