Skip to content

Installation on MacOS

pika edited this page Dec 19, 2024 · 2 revisions

⚠️ Known Issues

  • No binaries yet (you can download artifacts from each commit/PR tests)
  • App won't ever be sandboxed, hardened, notarized or signed.
    • If you don't trust the binaries please build from source. You still need to convince Apple you want to run the binary you just built.

Installation

  1. Choose a release from the releases page
  2. Click on the release tag
An arrow points to the tag field of a release
  1. View workflows for the latest commit and select details for any macOS release
image
  1. Select summary on the side and download the artifact appropriate for your device. Apple Silicon macs use arm64.
  2. Decompress the zip file, then decompress the 7z file using Keka or The Unarchiver.
  3. Move the application somewhere outside ~/Downloads
  4. Right click and open the application to bypass gatekeeper. You only need to do this for the first launch.

CLI interface

If you want to access koreader using the commandline don't do a symlink. Just export the PATH.

For example: for /Applications/KOReader.app do export PATH=$PATH:/Applications/KOReader.app/Contents/MacOS

Usage

Basic reading controls (click to open)
Advanced reading controls (click to open)
Clone this wiki locally