Skip to content

Repository files navigation

GediDocs app icon

GediDocs

An Android document reader with optional, on-device reading assistance.

Android 9+  ·  Kotlin  ·  Jetpack Compose

Important

GediDocs is not a medical device. Its assistance features are personal presentation controls, not medical advice, treatment, or an accessibility guarantee. Check important information against the original document.

What it does

  • Imports and keeps supported documents in a private, offline app library.
  • Reads PDF, EPUB, CBZ, DOCX, PPTX, Markdown, plain-text, and image files.
  • Provides device Text-to-Speech read-aloud when a compatible Android engine is available.
  • Lets readers choose only the assistance they want:
Assistance Designed for Includes
Motor & Hand Access Tremor or difficult touch input Page stabilization, larger controls, and forgiving targets
Reading Focus Losing place in dense text Reading ruler and typography controls for supported documents
Sensory Comfort Visual clutter, motion, or glare Zen controls, reduced motion, palettes, tint, and glare reduction

Shared reader settings include text size and high contrast. Assistance modules change the presentation only; they do not alter the imported file.

Quick start

Requirements

  • Android Studio with Android SDK 37 installed
  • JDK 17
  • Android 9 / API 28 or newer for running the app

Build

git clone https://github.com/bristo-biju/GediDocs.git
cd GediDocs
.\gradlew.bat assembleDebug

Install the generated debug APK from Android Studio, or with a connected device:

.\gradlew.bat installDebug

Use

  1. Open GediDocs and select Import document.
  2. Choose a file and, if wanted, a library folder.
  3. Open it from the library.
  4. Use Settings to enable an assistance group or customize its features.

Privacy and safety

GediDocs currently has no accounts, cloud sync, analytics, advertising, or crash-reporting service. Imported documents and reader settings stay on the device. Read-aloud is provided by the Android Text-to-Speech engine selected on that device, which may have its own privacy practices.

Development

Run these checks before describing a change as verified:

.\gradlew.bat testDebugUnitTest
.\gradlew.bat lintDebug
git diff --check

Device testing is still needed for document rendering, touch interaction, sensors, and Android accessibility services.

Project guide

ADAPTIVE_MODULES.md is the concise implementation guide for document behavior, module IDs, and combination rules. Kotlin code remains the source of truth.

Contributing

Keep changes focused, preserve persisted module IDs, and update the project guide only for behavior that exists in code. Report bugs through the issue tracker without including private document content.

License

Original GediDocs code and assets are proprietary and released under the GediDocs Proprietary License. Third-party components are excluded from that license and remain under their original terms. See THIRD_PARTY_NOTICES.md.

About

On-device Android document reader with accessibility tools for tremor, motor access, reading focus, and sensory comfort.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages