From f2978ba7f2e1420e3c0a419c355cfaf10e327255 Mon Sep 17 00:00:00 2001 From: Sparsh Sam <110058692+sparshsam@users.noreply.github.com> Date: Mon, 29 Jun 2026 01:14:07 -0400 Subject: [PATCH] docs: refine README with CTA placement, feature grid, Built With, and philosophy quote MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Move primary CTA badges to right after hero screenshot (⭐ Get OpenReader) - Add social proof line below hero (Built for Windows 10 & 11 · Offline · Open Source · AI-ready) - Turn Features into scannable two-column grid with emoji markers - Replace Technology table with concise Built With list - Add philosophy blockquote to Design Philosophy section Co-Authored-By: Claude --- README.md | 58 ++++++++++++++++++++++++------------------------------- 1 file changed, 25 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index 2b53765..b204dd4 100644 --- a/README.md +++ b/README.md @@ -11,26 +11,26 @@

- Microsoft Store -   - Latest release + OpenReader reading a PDF

-

- Source Code -   - License -   - Downloads +

+ Built for Windows 10 & 11 · 100% Offline · Open Source · AI-ready

-
-

- OpenReader reading a PDF + ⭐ Get OpenReader

-
+

+ Microsoft Store +   + Portable Release +   + Project Website +   + Source Code +

--- @@ -47,18 +47,14 @@ ## Features -**Read** — Open PDFs, one-page or continuous scroll, fit-width, zoom, page jump. -**Annotate** — Highlight, underline, strikethrough, and sticky notes. Saved as native PDF annotations. -**Search** — Full-document keyword search with match count and navigation. -**Library search** — Index entire folders with SQLite FTS5 for cross-document BM25-ranked search. -**Semantic search** — TF-IDF cosine similarity for meaning-based matching — no external ML dependencies. -**Compare** — Side-by-side diff with color-coded changes (red delete, green insert) and structured summary. -**Multi-tab** — Open several documents in one window with movable, closeable tabs. -**Dark mode** — System-aware dark theme with Auto/Light/Dark toggle. -**PDF tools** — Merge, split, extract page ranges, and save compressed copies. -**OCR fallback** — Automatic OCR on scanned/image-based pages when Tesseract is available. -**Session restore** — Remembers open documents and page positions across restarts. -**AI agent integration** — Built-in MCP server with 14 tools for automated PDF workflows. +| | | +|---|---| +| **📖 Read** — Open PDFs, one-page or continuous scroll, fit-width zoom, page jump. | **📝 Annotate** — Highlight, underline, strikethrough, and sticky notes. Saved as native PDF annotations. | +| **🔍 Search** — Full-document keyword search with match count and navigation. | **📚 Library search** — Index entire folders with SQLite FTS5 for cross-document BM25-ranked search. | +| **🧠 Semantic search** — TF-IDF cosine similarity — meaning-based matching, no external ML. | **📊 Compare** — Side-by-side diff with color-coded changes and structured summary. | +| **📑 Multi-tab** — Open several documents in one window with movable tabs. | **🌙 Dark mode** — System-aware theme with Auto/Light/Dark toggle. | +| **🔧 PDF tools** — Merge, split, extract page ranges, compress. | **👁️ OCR fallback** — Automatic OCR on scanned/image-based pages when Tesseract is available. | +| **💾 Session restore** — Remembers open documents and page positions across restarts. | **🤖 AI agent integration** — Built-in MCP server with 14 tools for automated PDF workflows. | --- @@ -88,21 +84,17 @@ ## Design Philosophy +> *"Software should respect your documents. They stay on your computer, under your control."* + OpenReader is built around a single idea: **a PDF reader should feel like a well‑made tool, not a web page.** The interface follows native Windows conventions — real menus, keyboard shortcuts, proper window management — with a refined dark theme (Tokyo Night‑inspired) and a clean light option. Every interaction is immediate, every feature discoverable without tutorials. The focus is on reading and working with documents, not fighting the interface. Toolbar buttons have clear vector‑drawn icons, tabs are movable, zoom is instant, and the reading view puts your document first. --- -## Technology +## Built With -| | | -|---|---| -| **Python 3.11+** — Core application logic | **PySide6 (Qt 6)** — Native Windows UI | -| **PyMuPDF (MuPDF)** — PDF rendering | **SQLite FTS5** — Keyword and full‑text search | -| **scikit‑learn** — Semantic (TF‑IDF) search | **MCP** — AI agent integration protocol | -| **PyInstaller** — Windows packaging | **MSIX** — Microsoft Store distribution | -| **Tesseract** — OCR fallback for scanned pages | | +🐍 Python   ·   🪟 Qt 6   ·   📄 MuPDF   ·   🔍 SQLite   ·   👁️ Tesseract   ·   🤖 MCP   ·   📦 PyInstaller   ·   🏪 MSIX ---