readme update

This commit is contained in:
endernon 2024-12-16 00:43:47 +00:00
parent deb0124fe6
commit 6488e6866c

View file

@ -6,21 +6,29 @@ This tool will not overcome any protection to the zip archive itself. See a prog
# Usage # Usage
## CLI ## 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 #### 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 - download this repository
- run `cargo build --release` in the directory - run `cargo build --release` in the directory
- check `./target/release` - check `./target/release`
- run - run
- `rpfixer` if you are on linux/mac (RUN `chmod +x rpfixer` ON IT FIRST) - `rpfixer` if you are on linux/mac (RUN `chmod +x rpfixer` ON IT FIRST)
- `rpfixer` if you are on windows - `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 ## Function library
- The library has one function: `rpfixer::fix`. Use a `Vec<u8>` in it. - The library has one function: `rpfixer::fix`. Use a `Vec<u8>` in it.