Skip to content

README.md improvements #86

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
neocturne merged 2 commits into from
Nov 2, 2025
Merged

README.md improvements #86

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bb3fa8b
README.md: add link to demo
neocturne Nov 2, 2025
7406a99
README.md: fix incomplete sentence
neocturne Nov 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ based on [Leaflet](https://leafletjs.com/). The map renderer is heavily inspired
[MapRend](https://github.com/YSelfTool/MapRend), but has been reimplemented from scratch
(first in C++, now in Rust) for highest performance.

Demo: https://neocturne.github.io/MinedMap/

## How to use

Download the binary release that matches your platform from the Github release
Expand All @@ -30,8 +32,8 @@ 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
tile data from a save game called "World", use the a command like the following
and `C:\Users\<username>\AppData\Roaming\.minecraft\saves` on Windows. To generate
MinedMap tile data from a save game called "World", use the a command like the following
(replacing the first argument with the path to your save data; `<viewer>` refers
to the directory where you unpacked the MinedMap viewer):
```shell
Expand Down