cdanesi/tdf
1
0
Fork 0
mirror of https://github.com/itsjunetime/tdf.git synced 2026-06-02 08:01:47 -04:00
Code Issues Packages Projects Releases Wiki Activity

Clarify some installation and build behavior in README.md

Browse Source
This commit is contained in:
itsjunetime
2025-04-14 12:11:02 -06:00
parent 69d5f96375
commit 475d45a6f6
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+7
View File
@@ -13,6 +13,11 @@ Designed to be performant, very responsive, and work well with even very large P
- Responsive details about rendering/search progress - Responsive details about rendering/search progress
- Reactive layout - Reactive layout
## Installation
1. Get the rust toolchain from [rustup.rs](https://rustup.rs)
2. Run `rustup install nightly && cargo +nightly install --git https://github.com/itsjunetime/tdf.git`
## To Build ## 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`. 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`.
@@ -22,6 +27,8 @@ If it turns out that you're missing one of these, it will fail to compile and te
2. Clone the repo and `cd` into it 2. Clone the repo and `cd` into it
3. Run `cargo build --release` 3. Run `cargo build --release`
The binary should then be found at `./target/release/tdf`.
## Why in the world would you use this? ## Why in the world would you use this?
I dunno. Just for fun, mostly. I dunno. Just for fun, mostly.