neocturne/MinedMap
1
0
Fork 0
mirror of https://github.com/neocturne/MinedMap.git synced 2025-03-04 17:23:33 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

README.md: minor updates

Browse source
This commit is contained in:
Matthias Schiffer 2023-11-18 18:51:11 +01:00
parent 2c1c8c17ef
commit 412568603e
Signed by: neocturne
GPG key ID: 16EF3F64CB201D9C
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -17,8 +17,8 @@
MinedMap consists of two components: a map renderer generating map tiles from MinedMap consists of two components: a map renderer generating map tiles from
Minecraft save games, and a viewer for displaying and navigating maps in a browser Minecraft save games, and a viewer for displaying and navigating maps in a browser
based on [Leaflet](https://leafletjs.com/). The map renderer is heavily inspired by based on [Leaflet](https://leafletjs.com/). The map renderer is heavily inspired by
[MapRend](https://github.com/YSelfTool/MapRend), but it has been implemented in C++ [MapRend](https://github.com/YSelfTool/MapRend), but has been reimplemented from scratch
from scratch for highest performance. (first in C++, now in Rust) for highest performance.
The viewer expects the the map data in a directory named `data`. To generate a new The viewer expects the the map data in a directory named `data`. To generate a new
map, create this empty directory inside the viewer directory. Next, to generate the map, create this empty directory inside the viewer directory. Next, to generate the
@ -48,8 +48,8 @@ the generated map files to public webspace to make the map available to others.
## Installation ## Installation
Building the MinedMap map generator requires a recent Rust toolchain. The Building the MinedMap map generator from source requires a recent Rust toolchain. The
following command can be used to build the current development version from source: following command can be used to build the current development version:
```shell ```shell
cargo install --git 'https://github.com/NeoRaider/MinedMap.git' cargo install --git 'https://github.com/NeoRaider/MinedMap.git'
``` ```