tdf

A terminal-based PDF viewer.

Designed to be performant, very responsive, and work well with even very large PDFs. Built with ratatui.

Features:

• Asynchronous Rendering
• Searching
• Hot reloading
• Responsive details about rendering/search progress
• Reactive layout

Installation

1. Get the rust toolchain from rustup.rs
2. Run cargo install --git https://github.com/itsjunetime/tdf.git

If you want to use this with epubs or cbzs, add --features epub or --features cbz to the command line (or --features cbz,epub for both)

To Build

First, you need to install the system dependencies. This will generally only include libfontconfig and clang. If you're on linux, these will probably show up in your package manager as something like libfontconfig1-devel or libfontconfig-dev and just clang.

If it turns out that you're missing one of these, it will fail to compile and tell you what library you're missing. Find the development package for that library in your package manager, install it, and try to build again. Now, the important steps:

1. Get the rust toolchain from rustup.rs
2. Clone the repo and cd into it
3. Run cargo build --release

The binary should then be found at ./target/release/tdf.

Why in the world would you use this?

I dunno. Just for fun, mostly.

Can I contribute?

Yeah, sure. Please do.

Please note, though, that all contributions will be treated as licensed under MPL-2.0.