Skip to content

Commit

Permalink
README.md: some rewording
Browse files Browse the repository at this point in the history
  • Loading branch information
neocturne committed Mar 3, 2024
1 parent 00eea45 commit bccd6d6
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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\<username>\AppData\Roaming\.minecraft\saves`. To generate MinedMap
Expand All @@ -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
`<viewer>/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
`<viewer>/data/processed` directory, as that is only used locally to allow processing
updates more quickly.

### Signs

Expand Down

0 comments on commit bccd6d6

Please sign in to comment.