Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kruserr/rustic-reader
A minimalistic ebook reader
https://github.com/kruserr/rustic-reader
cli cli-utility pdf pdf-reader terminal terminal-utility unix utility
Last synced: 1 day ago
JSON representation
A minimalistic ebook reader
- Host: GitHub
- URL: https://github.com/kruserr/rustic-reader
- Owner: kruserr
- License: agpl-3.0
- Created: 2024-06-13T16:51:05.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-10-19T16:36:46.000Z (26 days ago)
- Last Synced: 2024-11-03T09:29:00.324Z (11 days ago)
- Topics: cli, cli-utility, pdf, pdf-reader, terminal, terminal-utility, unix, utility
- Language: Rust
- Homepage: https://crates.io/crates/rustic-reader
- Size: 26 MB
- Stars: 7
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RusticReader
A minimalistic ebook reader
## Overview
The goal of this project is to build an ebook reader that has a minimal set of features, that make ebook reading enjoyable on a desktop computer.
Furthermore we are building a seamless experience for reading ebooks, both on a desktop computer and a tablet or ereader 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
- Saves progress
- Written in pure Rust
- Cross platform
- Each component in the CLI client is exposed as a UNIX style utility
## Quick start guide
### Install the CLI client
```sh
cargo install --locked rustic-reader
rustic-reader document.pdf
```
for scanned document support
```sh
sudo apt install ocrmypdf tesseract-ocr-eng
```
then use the `--ocr=true` flag
```sh
rustic-reader --ocr=true document.pdf
```
For further install instructions read the [Getting started page](docs/pages/getting-started.md)
## Documentation
Visit the [Documentation](docs/README.md)
## Roadmap
- [x] Plain text format support
- [x] PDF format support
- [x] EPUB format support
- [x] Convert scanned documents and images to plain text with ocrmypdf
- [x] Auto saving progress
- [ ] Offline PWA web client
- [ ] Server to sync progress
- [ ] Integrated command line
- [ ] Text highlighting
- [ ] Extend server to sync books and highlights
- [ ] Support more ebook and document formats
- [ ] CLI client image to ascii art converter
- [ ] Natural sounding ai voice model for text to speech narration