Introduction

Welcome to the Palmreader documentation! This website hosts guides, references, and release notes for the Palmreader software.

Unless otherwise specified, all documentation is written for the latest version of Palmreader.

Documentation Status

This documentation is still a work-in-progress. If you can’t find what you’re looking for, please reach out to us. Reaching out helps us understand which pages we should prioritize.

Sections

The documentation for Palmreader is split into 3 sections:

  1. Guides
  2. Reference
  3. Releases

Guides

Guides contain step-by-step instructions for performing certain actions in Palmreader. They may not contain information about every visible option and are geared towards introducing you to the fundamental capabilities of the software. We recommend you start here.

Reference

The reference section is designed to provide information about every detail of the software. If you find a button whose purpose you don’t understand, there’s likely a reference about the page or section that contains information about that button. If not, please reach out to us!

Understanding reference pages

Currently, all reference pages follow a format: an annotated screenshot of a specific page in Palmreader, then a description and explanation for every annotated element. Any information not directly related to a specific UI element is described at the end of the reference page.

Releases

Each new release of Palmreader will display changelogs within the application when asking you to upgrade. Those changelogs also exist in the Releases tab, allowing you to reference past updates and understand what we’ve been working on.