From 5cf198b8e10dddcd5ae11f409e1487cdf39c3dad Mon Sep 17 00:00:00 2001 From: endernon Date: Mon, 16 Dec 2024 00:45:48 +0000 Subject: [PATCH] better readme --- readme.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/readme.md b/readme.md index 49ec5a1..d6c6da3 100644 --- a/readme.md +++ b/readme.md @@ -12,8 +12,8 @@ This tool will not overcome any protection to the zip archive itself. See a prog - 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) +- Open a command prompt (windows) and run rpfixer.exe +- Open a terminal / terminal emulator (linux) and run rpfixer.exe #### Cargo - Download the Rust-Lang for your system (WARNING: THIS IS LIKE 10GIGABYTES ON WINDOWS) @@ -30,6 +30,13 @@ This tool will not overcome any protection to the zip archive itself. See a prog - `rpfixer` if you are on linux/mac (RUN `chmod +x rpfixer` ON IT FIRST) - `rpfixer` if you are on windows +## Syntax for CLI + +Check `--help` for syntax. + +Example syntax: `rpfixer --path ./filepath/` + + ## Function library - The library has one function: `rpfixer::fix`. Use a `Vec` in it. #### Example code @@ -43,12 +50,6 @@ fn main() { ``` -# Syntax - -Check `--help` for syntax. - -Example syntax: - # License