make README.md actually good, edit the error messages
This commit is contained in:
parent
ac31624f05
commit
5346e870e4
2 changed files with 14 additions and 11 deletions
13
README.md
13
README.md
|
@ -3,11 +3,14 @@ Basically this generates fake items by loading from a json. Effectively a wrappe
|
||||||
|
|
||||||
## How to get the program
|
## How to get the program
|
||||||
### Option 1: prebuilt
|
### Option 1: prebuilt
|
||||||
Go to the releases tab
|
Go to the [releases tab](https://git.frfrnocap.men/endernon/idmangler-cli/releases)
|
||||||
|
### Option 2: compile yourself
|
||||||
## how to use:
|
|
||||||
|
|
||||||
requirements: rust, cargo
|
requirements: rust, cargo
|
||||||
use cargo run --release to build and run
|
use cargo run --release to build and run.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
Move the program to some folder. Download these three files and place them next to the program:
|
||||||
|
https://git.frfrnocap.men/endernon/idmangler-cli/raw/branch/main/config.json
|
||||||
|
https://raw.githubusercontent.com/Wynntils/Static-Storage/main/Reference/id_keys.json
|
||||||
|
https://raw.githubusercontent.com/Wynntils/Static-Storage/main/Data-Storage/shiny_stats.json
|
||||||
read the provided config markdown file to understand how to edit config.json
|
read the provided config markdown file to understand how to edit config.json
|
||||||
|
|
12
src/main.rs
12
src/main.rs
|
@ -258,10 +258,10 @@ fn pass() {
|
||||||
|
|
||||||
const ERROR: [&'static str; 7] = [
|
const ERROR: [&'static str; 7] = [
|
||||||
"Error 0: what did you even do to get this? ",
|
"Error 0: what did you even do to get this? ",
|
||||||
"Error 1: json config file is missing, obtain it from https://git.frfrnocap.men/endernon/idmangler-cli/raw/branch/main/config.json and move it to this directory. ",
|
"Error 1: json config json is missing, obtain it from https://git.frfrnocap.men/endernon/idmangler-cli/raw/branch/main/config.json and move it to this directory. ",
|
||||||
"Error 2: json config is broken. Reread the example data or reobtain it from https://git.frfrnocap.men/endernon/idmangler-cli/raw/branch/main/config.json and move it to this diirectory. ",
|
"Error 2: json config json is corrupt. Reread config.md or reobtain it from https://git.frfrnocap.men/endernon/idmangler-cli/raw/branch/main/config.json and move it to this diirectory. ",
|
||||||
"Error 3: Identifications hashmap not found. Get it from https://raw.githubusercontent.com/Wynntils/Static-Storage/main/Reference/id_keys.json and move it to this directory. ",
|
"Error 3: Identifications hashmap is missing. Get it from https://raw.githubusercontent.com/Wynntils/Static-Storage/main/Reference/id_keys.json and move it to this directory. ",
|
||||||
"Error 4: Identifications hashhmap is corrupt. Reobtain it from https://raw.githubusercontent.com/Wynntils/Static-Storage/main/Reference/id_keys.json and move it to this directory. ",
|
"Error 4: Identifications hashmap is corrupt. Reobtain it from https://raw.githubusercontent.com/Wynntils/Static-Storage/main/Reference/id_keys.json and move it to this directory. ",
|
||||||
"Error 5: Shiny data json is missing. Get it from https://raw.githubusercontent.com/Wynntils/Static-Storage/a8469fad2f3bd0fc0fe2678eeb812d7877c9e61b/Data-Storage/shiny_stats.json and move it to this directory. ",
|
"Error 5: Shiny data json is missing. Get it from https://raw.githubusercontent.com/Wynntils/Static-Storage/main/Data-Storage/shiny_stats.json and move it to this directory. ",
|
||||||
"Error 6: Shiny data json is corrupt. Get it from https://raw.githubusercontent.com/Wynntils/Static-Storage/a8469fad2f3bd0fc0fe2678eeb812d7877c9e61b/Data-Storage/shiny_stats.json and move it to this directory. "
|
"Error 6: Shiny data json is corrupt. Get it from https://raw.githubusercontent.com/Wynntils/Static-Storage/main/Data-Storage/shiny_stats.json and move it to this directory. "
|
||||||
];
|
];
|
||||||
|
|
Loading…
Reference in a new issue