add readme

At-Heal · Dec 30, 2020 · 5152c10 · 5152c10
1 parent 6d5cc66
commit 5152c10
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/readme.md b/readme.md
@@ -0,0 +1,16 @@
+# landis
+
+A simple out-of-band Minecraft world map renderer and leaflet-based frontend
+
+### usage
+
+- create an `out` dir
+- put a minecraft server at `./mcserver`
+- `cargo run`
+- let world save/generate, etc
+- visit http://localhost:3090/
+- refresh for new tiles
+
+### screenshot
+
+![image](https://cdn.discordapp.com/attachments/412407865911803906/793817001210019871/unknown.png)