From a2914bdb33a7cfeb2ba8f1caf36eb73da64c9344 Mon Sep 17 00:00:00 2001 From: endernon Date: Sat, 14 Sep 2024 21:34:33 +0100 Subject: [PATCH] make the usage section of README more detailed for people --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7635acf..42ae00d 100644 --- a/README.md +++ b/README.md @@ -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