endernon/idmangler-cli
1
0
Fork 0
Code Issues Pull requests Projects Releases 4 Packages Wiki Activity Actions

make the usage section of README more detailed for people

Browse source
This commit is contained in:
endernon 2024-09-14 21:34:33 +01:00
parent fd7bc7acc8
commit a2914bdb33
1 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -12,10 +12,13 @@ requirements: rust, cargo
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://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
- Move the program to some folder along with config.json . Download these three files and place them next to the program:
- 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
- Open a terminal (Windows: use cmd or Powershell , Linux: use your preferred Terminal Emulator)
- Use the command "cd DIRECTORY" (where DIRECTORY is where the program is stored)
- read the provided config markdown file to understand how to edit config.json