From 00727b9913ff8f685852af75ecf8b368cd84b493 Mon Sep 17 00:00:00 2001 From: futile Date: Tue, 22 Apr 2025 14:34:37 +0100 Subject: [PATCH] add compilation instructions to the repo --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 6a8a28c..645ee5c 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,10 @@ A toolset of convenient things for GTA V Online. ![](https://i.vgy.me/maLh8W.png) + +## Installing +**Option 1** - Download +Download the latest release [here](https://codeberg.org/futile/gta-tools/releases/download/latest/gta-tools.exe) and place it somewhere convenient for you, such as Documents. You could then make a shortcut titled "GTA Tools", and pin it to taskbar or Start. + +**Option 2** - Build from source +You will need the Rust toolchain, which can be obtained [here](https://rustup.rs). Follow the instructions of its installer. Once you have Rust installed, clone this repo and navigate to it. You can then run `cargo build --release`. Once you do that, you can use the binary located at `.\target\release\gta-tools.exe` in the same way as **Option 1**.