From 6488e6866cb8b11f0397ea1a3d8d82700cf5c9a2 Mon Sep 17 00:00:00 2001 From: endernon Date: Mon, 16 Dec 2024 00:43:47 +0000 Subject: [PATCH] readme update --- readme.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/readme.md b/readme.md index 44d4c9f..49ec5a1 100644 --- a/readme.md +++ b/readme.md @@ -6,21 +6,29 @@ This tool will not overcome any protection to the zip archive itself. See a prog # Usage - ## CLI +#### Premade package (easiest) +- Go to the releases tab +- Download for your system and unzip it +- (Step for linux users only) run `chmod +x` on the executable +- Open a command prompt (windows) +- Open a terminal / terminal emulator (linux) + +#### Cargo +- Download the Rust-Lang for your system (WARNING: THIS IS LIKE 10GIGABYTES ON WINDOWS) +- run `cargo install rpfixer` +- Then run the `rpfixer` command + #### Manual clone -- download the Rust-Lang for your system +- You really should not do this +- download the Rust-Lang for your system (WARNING: THIS IS LIKE 10GIGABYTES ON WINDOWS) - download this repository - run `cargo build --release` in the directory - check `./target/release` - run - `rpfixer` if you are on linux/mac (RUN `chmod +x rpfixer` ON IT FIRST) - `rpfixer` if you are on windows -#### Cargo -- Download the Rust-Lang for your system -- run `cargo install rpfixer` -- Then run the `rpfixer` command ## Function library - The library has one function: `rpfixer::fix`. Use a `Vec` in it.