12 releases

new 0.1.11 Nov 26, 2024
0.1.10 Nov 20, 2024
0.1.6 Oct 19, 2024
0.1.3 Sep 22, 2024
0.1.1 Jun 14, 2024

#2193 in Parser implementations

Download history 1/week @ 2024-09-02 113/week @ 2024-09-16 73/week @ 2024-09-23 11/week @ 2024-09-30 262/week @ 2024-10-07 328/week @ 2024-10-14 45/week @ 2024-10-21 317/week @ 2024-11-04 6/week @ 2024-11-11 295/week @ 2024-11-18

621 downloads per month
Used in 8 crates

AGPL-3.0

21KB
217 lines

hygg

Simplifying the way you read

Overview

The goal of this project is to build an ebook and document reader that has a minimal set of features, that make reading enjoyable on a desktop computer.

A large emphasis is on making a minimalistic and distraction free environment for you to easily focus on what is important, the content.

Furthermore we are working on building a seamless experience for reading ebooks but also more generally documents, both on a desktop computer and a tablet or e-reader with a browser.

Features

  • CLI client
    • Converts regular or scanned PDF or EPUB to plain text
    • Justifies the plain text to specified column width
    • Horizontally centers the text
    • Minimalistic less like interactive reader with vim like bindings (still work in progress)
    • Saves progress
    • Cross platform
    • Each component in the CLI client is exposed as a UNIX style utility for easy code reuse in your own open source project

Quick start guide

Install the CLI client

cargo install --locked hygg
hygg doc.pdf

for scanned document support

sudo apt install ocrmypdf tesseract-ocr-eng

then use the --ocr=true flag

hygg --ocr=true doc.pdf

For further install instructions read the Getting started page

Documentation

Visit the Documentation

Roadmap

  • Plain text format support
  • PDF format support
  • EPUB format support
  • Convert scanned documents and images to plain text with ocrmypdf
  • Auto saving progress
  • Integrated command line with vim like commands
  • Server to sync progress and books
  • Text highlighting with server sync
  • Start screen to show overview of books and progress
  • Image to ascii art converter
  • Natural sounding ai voice model for text to speech narration
  • Run all inference directly in rust
  • Offline PWA web client
  • Support more ebook and document formats

Dependencies

~20MB
~311K SLoC