ソースを参照

Documentation

Mark Ide 8 年 前
コミット
01ecfbca2f
1 ファイル変更17 行追加2 行削除
  1. 17 2
      README.md

+ 17 - 2
README.md

@@ -1,2 +1,17 @@
-# minecraft-render
-Docker Container to Run Minecraft Overviewer
+# Minecraft Render Docker Container
+
+Docker Container to Run [Minecraft Overviewer](https://overviewer.org/). Overviewer is a render that produces a Google Maps render of a [Minecraft](https://minecraft.net/en/) world.
+
+## Goals
+
+The goal of this container is to easily run [Minecraft Overviewer](https://overviewer.org/). Now you don't need to worry about the dependencies.
+
+## Running Minecraft Overviewer
+
+```
+docker run \
+  -e MINECRAFT_VERSION=1.10 \
+  -v /home/user/minecraft/:/home/minecraft/server/:ro \
+  -v /srv/http/minecraft/:/home/minecraft/render/:rw \
+  mide/minecraft-render
+```