mirror of
https://github.com/itsjunetime/tdf.git
synced 2026-06-01 23:51:46 -04:00
itsjunetime
47 lines
1.8 KiB
Markdown
47 lines
1.8 KiB
Markdown
# `tdf`
|
|
|
|
A terminal-based PDF viewer.
|
|
|
|
Designed to be performant, very responsive, and work well with even very large PDFs. Built with [`ratatui`](https://github.com/ratatui-org/ratatui).
|
|
|
|
|
|
|
|
## Features:
|
|
- Asynchronous Rendering
|
|
- Searching
|
|
- Hot reloading
|
|
- Responsive details about rendering/search progress
|
|
- Reactive layout
|
|
|
|
## Installation
|
|
|
|
1. Get the rust toolchain from [rustup.rs](https://rustup.rs)
|
|
2. Run `cargo install --git https://github.com/itsjunetime/tdf.git`
|
|
|
|
If you want to use this with `epub`s or `cbz`s, 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](https://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`.
|
|
|
|
You can also pull this in via [radicle](https://radicle.xyz) with `rad clone rad:zb11K1XGfQooopqEfwtCMyvbcyK1`
|
|
|
|
## 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:
|
|
1. No AI-generated or AI-assisted or AI-viewed or AI-anythinged code will be accepted. "AI" is a plague upon this earth and I won't be caught dead pretending it's normal.
|
|
2. All contributions will be treated as licensed under MPL-2.0 :)
|