From 475d45a6f612bc3d2492f287cbf3b0cbed8928e2 Mon Sep 17 00:00:00 2001 From: itsjunetime Date: Mon, 14 Apr 2025 12:11:02 -0600 Subject: [PATCH] Clarify some installation and build behavior in README.md --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 0843e5a..89ca17d 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,11 @@ Designed to be performant, very responsive, and work well with even very large P - Responsive details about rendering/search progress - 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 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 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.