Skip to content

Commit 7c1989a

Browse files
committedAug 5, 2016
Improve README (fixes #30)
1 parent 2aa8619 commit 7c1989a

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed
 

‎README.rst

+12-6
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ Minetest Mapper C++
44
.. image:: https://travis-ci.org/minetest/minetestmapper.svg?branch=master
55
:target: https://travis-ci.org/minetest/minetestmapper
66

7-
A port of minetestmapper.py to C++ from https://github.com/minetest/minetest/tree/master/util
7+
A port of minetestmapper.py to C++ from https://github.com/minetest/minetest/tree/master/util.
8+
This version is both faster and provides more features than the now deprecated Python script.
89

910
Requirements
1011
------------
@@ -14,23 +15,28 @@ Requirements
1415
* leveldb (optional, set ENABLE_LEVELDB=1 in CMake to enable leveldb support)
1516
* hiredis (optional, set ENABLE_REDIS=1 in CMake to enable redis support)
1617

18+
e.g. on Debian:
19+
^^^^^^^^^^^^^^^
20+
21+
sudo apt-get install libgd-dev libsqlite3-dev libleveldb-dev libhiredis-dev
22+
1723
Compilation
1824
-----------
1925

2026
::
2127

22-
cmake .
23-
make
28+
cmake . -DENABLE_LEVELDB=1
29+
make -j2
2430

2531
Usage
2632
-----
2733

28-
Binary `minetestmapper` has two mandatory paremeters, `-i` (input world path)
34+
`minetestmapper` has two mandatory paremeters, `-i` (input world path)
2935
and `-o` (output image path).
3036

3137
::
3238

33-
./minetestmapper -i ~/.minetest/worlds/my_world/ -o ~/map.png
39+
./minetestmapper -i ~/.minetest/worlds/my_world/ -o map.png
3440

3541

3642
Parameters
@@ -58,7 +64,7 @@ draworigin:
5864
Draw origin indicator, `--draworigin`
5965

6066
drawalpha:
61-
Allow blocks to be drawn with transparency, `--drawalpha`
67+
Allow nodes to be drawn with transparency, `--drawalpha`
6268

6369
noshading:
6470
Don't draw shading on nodes, `--noshading`

0 commit comments

Comments
 (0)
Please sign in to comment.