Skip to content
Ares-XPublic

About

A lightweight, open-source macOS reader for ebooks, comics, images, Markdown and PDF. Native app for Apple Silicon.

Topics

Resources

Stars

4 stars

Watchers

0 watching

Forks

Repository files navigation

Sumra — a lightweight, open-source reader for macOS

Sumra — A Lightweight macOS Reader

Ebooks, comics, PDFs, images and Markdown. One native Mac app, focused on reading.

English · 简体中文 · 繁體中文 · 日本語

macOS 13+ · Apple Silicon · Free and open source

Download for Mac · Release notes · Supported formats · Build from source · Report an issue

Open an EPUB novel, a comic archive, a folder of images, Markdown notes or a PDF from Finder. Read in native Mac windows and tabs, choose your layout, and use contents, search and bookmarks to find your place.

Sumra displaying Markdown reading notes and contents in light mode

More screenshots: two-page reading, recent files and dark mode

Two-page reading with the contents sidebar

Recent documents on the Home screen

Reading in dark mode

All screenshots use the repository's original demo document.

Install and start reading

  1. Download the app ZIP from the latest release and unzip it.
  2. Move Sumra.app to Applications, then open it.
  3. Press ⌘O or drag a file into the window. Press ⌘F to search its text.

Public builds use the maintainer's Ares-X Code Signing self-signed certificate, rather than an Apple Developer ID certificate, and are not notarized. If macOS blocks the first launch and you trust the download, follow Apple's instructions: open System Settings → Privacy & Security → Open Anyway, then confirm.

Updates: choose Help → Check for Updates, or enable automatic checks in Settings. Sparkle verifies the update and installs it after your confirmation. Each release also includes corresponding source and SHA-256 checksums.

Compatibility and older installations

The release targets Apple Silicon (arm64) and macOS 13 or later. Bundled executables and libraries are checked for arm64 support, deployment targets and runtime dependencies. GUI acceptance has been performed on macOS 27.0.1; a physical macOS 13 machine has not yet been verified.

Version 0.2.0 has no update feed. Install a newer release manually once; 0.2.1 and later support in-app updates. PostScript and EPS require a separate Ghostscript installation.

Made for reading

  • Native windows and tabs. Open from Finder, drag files into Sumra, or continue from Home. Enable Use window tabs in Settings to keep multiple books together.
  • A layout that suits the document. Single-page, continuous scrolling and two-page spreads, with themes and typography controls. Reflowable books adapt to the window; fixed pages keep their original geometry.
  • Find your place. Contents, chapter-title search, full-text search, thumbnails, bookmarks and optional reading-position history. TXT and MOBI can detect standalone chapter titles when an authored table of contents is absent.
  • Navigate comic collections. Archive folders become Contents entries with their names and nesting preserved. Suitable solid LZMA2 archives support distant jumps through an in-memory section index, without modifying the original or writing an extracted book cache.
  • Work with PDFs. Fill forms, edit annotations, undo and redo, extract or merge pages, and save your changes. PDF editing is locked until you choose Enable Editing. Save a Copy retains editable forms and annotations; Export PDF makes a static reading copy.
  • Listen, print and export. Read text or a selection aloud with system speech, print through the macOS print panel, or export a PDF. Available operations depend on the format and document permissions.

Use the sidebar for Contents, thumbnails and bookmarks, the View menu for layout and theme, and Settings for typography, history and tabs. Help → Keyboard Shortcuts lists commands; shortcuts can be customized in Settings.

Choose from five built-in reading themes, or save your own text, background and link colors. View → Document Colors → Choose Theme… previews the selection; Customize… creates a named palette or edits the selected custom theme. Previously saved theme settings remain readable:

Preview of Sumra's five built-in reading themes

Choose installed fonts from the reading Font menu or Settings. The Aa reading-settings button applies typography, colors and layout live; Typography and CSS… also accepts a family name, such as Iowan Old Style, including supplemental fonts macOS omits from its available-font list. Install your own font files with macOS Font Book first. Light uses pure white paper. For per-document text, background and link colors, open View → Document Colors → Custom Document Colors…. Color wells, RGB fields and an instant preview help you choose; Use Theme restores the theme palette.

CHM files expose a separate Index tab when they contain a keyword index. EPUB and comic files also have Finder thumbnails and a paged Quick Look preview; macOS manages the bundled extensions. Editor SyncTeX integration and reading controls describe the available GUI workflows.

Supported formats

Type Formats
PDF and fixed pages PDF, XPS / OXPS, SVG, DjVu
Ebooks EPUB, MOBI, AZW, PRC, FB2 / compressed FB2
Comics and images CBZ, CBR, CB7, CBT, image folders; common image formats including GIF, TIFF and JPEG XL
Text and web Markdown, HTML / XHTML, CHM, TXT and related plain text, TCR
Other compatible formats PDF-compatible AI, P7M envelopes, LIT
Requires additional software PostScript / EPS: install Ghostscript separately

Support varies by file variant. Sumra does not provide OCR or DRM removal; scanned pages need an existing text layer for text search.

Rendering notes and format limitations
  • Markdown uses MuPDF, with an optional WebKit compatibility mode. HTML and CHM use WebKit for reading; their printing and PDF export use MuPDF layout and may look different from the reading view.
  • Reflowable ebooks and native Markdown compact redundant blank prose rows and empty paragraphs, while preserving preformatted text, tables, image blocks and explicit page breaks. Recognized CHM prose also uses compact paragraph spacing; changing its font, size or line spacing overrides publisher styles.
  • Neutral text scans in PDFs gain contrast automatically. Turn Enhance Scanned Pages off under View → Document Colors to see the original appearance. The source file stays unchanged.
  • Section indexing skips earlier independent sections in suitable comic archives. A first jump still needs to decode preceding data within the target section; it does not make every unseen jump instantaneous.

See format and engine coverage, Markdown rendering and comic section seeking for details.

Build from source

You need macOS, the Apple Swift toolchain and macOS SDK, and CMake. The first build needs internet access to fetch pinned native dependencies and Sparkle. Project build and packaging scripts use Swift and system tools; Python is not required.

git clone https://github.com/Ares-X/Sumra.git
cd Sumra
./scripts/build-app.sh --release
open dist/Sumra.app

If needed, install CMake with your package manager, for example brew install cmake. For a development build and launch, use ./scripts/run-dev.sh. Local builds are ad-hoc signed by default.

Sumra is a graphical application; opening files, document tools and printing use its interface. For development, see the implementation notes, local checks and release procedure.

Contribute and translate

Settings marks partially translated interface languages; missing labels use English. Document font coverage is separate and depends on embedded, bundled and installed fonts. See language support and validation for tested scripts and current layout limits.

Bug reports, feature requests and pull requests are welcome. Include the macOS and Sumra versions, file format, reproduction steps and a shareable sample when possible.

The README is available in English, Simplified Chinese, Traditional Chinese and Japanese. Use README.md as the content reference, keep the same section order, and update the other versions when shared information changes. All versions reuse the same screenshots and link to the technical documentation.

License and acknowledgments

New Sumra code is licensed under AGPL-3.0-or-later. Upstream and ported components retain their own licenses and copyright notices; see THIRD_PARTY.md for sources, versions and licenses.

Inspired by SumatraPDF, Sumra reuses MuPDF and parts of SumatraPDF's document handling with a SwiftUI and AppKit interface. Thanks to MuPDF and the other upstream projects. Sumra is independently developed; the reference notes describe feature coverage and remaining differences.

About

A lightweight, open-source macOS reader for ebooks, comics, images, Markdown and PDF. Native app for Apple Silicon.

Topics

Resources

Stars

4 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages