mirror of
https://github.com/itsjunetime/tdf.git
synced 2026-06-01 23:51:46 -04:00
June
b9a12650c6
* Relicense to GPLv3 since poppler is GPL and we must not violate that license * Add note to README that contributions will be licensed as MPL-2.0
34 lines
1.4 KiB
Markdown
34 lines
1.4 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
|
|
|
|
## To Build
|
|
First, you need to install the system dependencies. This includes packages such as (but not limited to) `cairo`, `gtk`, and `poppler`. If you're on linux, these will probably show up in your package manager as something like `libcairo-devel` or `cairo-dev`.
|
|
|
|
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`
|
|
|
|
## 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. This is so that we can relicense to MPL-2.0 at some point in the future if we manage to move away from poppler as a backend (since that is the only dependency, at time of writing, which requires the GPLv3 license).
|