From bccd6d6cb4fad4a7d6bd8a7d3669ac4706428d6d Mon Sep 17 00:00:00 2001 From: Matthias Schiffer Date: Sun, 3 Mar 2024 23:43:42 +0100 Subject: [PATCH] README.md: some rewording --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 402c7b2..8f7867f 100644 --- a/README.md +++ b/README.md @@ -22,10 +22,12 @@ based on [Leaflet](https://leafletjs.com/). The map renderer is heavily inspired ## How to use -Download both the release that matches your platform, as well as the platform- -independant viewer archive. Extract the viewer archive. This directory will be made -publicly accessible on a web server and will contain both the html and javascript to -operate the viewer, as well as the image data generated by MinedMap. +Download the binary release that matches your platform from the Github release +page (or install from source using `cargo`), as well as the platform-independent +viewer archive. Extract the viewer archive. The extracted directory contains the +HTML and JavaScript to operate the viewer and will be made publicly accessible +on a web server. The image data generated by MinedMap will be stored in the +`data` subdirectory of the extracted viewer. Minecraft stores its save data in a directory `~/.minecraft/saves` on Linux, and `C:\Users\\AppData\Roaming\.minecraft\saves`. To generate MinedMap @@ -52,9 +54,9 @@ This test server is very slow and cannot handle multiple requests concurrently, a proper webserver like [nginx](https://nginx.org/) or upload the viewer together with the generated map files to public webspace to make the map available to others. -If you are uploading the directory to a remote webserver, you do not need to upload the -`/data/processed` directory, as that is only used locally to make updates -process more quickly. +If you are uploading the directory to a remote webserver, you do not need to upload the +`/data/processed` directory, as that is only used locally to allow processing +updates more quickly. ### Signs