mirror of
https://github.com/itsjunetime/tdf.git
synced 2026-06-01 23:51:46 -04:00
June
524c069b83
* Initial implementation of attempted mupdf rewrite * Change back to no resizing and don't include alpha channel in conversion * Remove some more dead code * Make features more modular and call search more easily * Switch to git dependency for my fixes * Update deps * Fix searching hehe * Remove unnecessary CI steps? * fontconfig in CI * perftools in ci * Final adjustments to conform to mupdf changes
34 lines
1.2 KiB
Markdown
34 lines
1.2 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 will generally only include `libfontconfig`. If you're on linux, these will probably show up in your package manager as something like `libfontconfig1-devel` or `libfontconfig-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.
|