readme

minetest-go · Jun 22, 2024 · c23e4a3 · c23e4a3
1 parent 6165481
commit c23e4a3
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 3 deletions.
diff --git a/iso_example.png b/iso_example.png
diff --git a/map_example.png b/map_example.png
diff --git a/readme.md b/readme.md
@@ -1,12 +1,39 @@
 
-Minetest map renderer library for go
+Minetest map renderer go-library and cli
 
 ![](https://github.com/minetest-go/maprenderer/workflows/test/badge.svg)
 [![Coverage Status](https://coveralls.io/repos/github/minetest-go/maprenderer/badge.svg)](https://coveralls.io/github/minetest-go/maprenderer)
 
-State: **WIP**
+# Usage
 
-# Licenses
+```sh
+# show help and usage
+./maprenderer -help
+```
+
+## Isometric map
+
+```sh
+./maprenderer -world /home/user/.minetest/worlds/myworld/ -from -200,-50,-200 -to 200,100,200 -type isometric
+```
+
+Example output:
+
+![](./iso_example.png)
+
+## Flat map
+
+```sh
+./maprenderer -world /home/user/.minetest/worlds/myworld/ -from -200,-50,-200 -to 200,100,200 -type map
+```
+
+![](./map_example.png)
+
+# Binary downloads
+
+See: https://github.com/minetest-go/maprenderer/releases
+
+# License
 
 Code: **MIT**