Skip to content

ajmwagar/tread

Repository files navigation

📖 tread

tread - (Terminal Reader) is a tool to help you read documents and e-books quickly from the safety of your terminal.

Features

  • Supports multiple file-formats:
    • Plaintext (txt, markdown, etc)
    • Coming Soon! E-books (epub, pdf, mobi)
    • Web Formats (html)
  • Toggleable Status Bar
  • Pause, Rewind, Fastforward Controls
  • TTR (Time to Read) Estimation
  • Adjustable WPM (Words Per Minute)
  • Bookmarks (Save position on exit)

📦 Installation & 🔨 Usage

tread is easy to install if you have cargo.

cargo install tread

Usage is just as simple.

tread ./that-book-i-really-need-to-finish.txt

Controls:

  • h: toggle the status bar
  • r: Restart the document
  • SPACE: pause the reader
  • LEFT & RIGHT Arrows: Move go back or forward a word.
  • UP & DOWN Arrows: Adjust WPM by 50 WPM.
  • ESC & q: Quits tread

About

📖 Read documents and e-books quickly from the safety of your terminal

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages