adrido/minetest-mapper-cpp
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Some fixes to the documentation

Browse Source
This commit is contained in:
Rogier 2015-11-26 17:40:57 +01:00
parent 0288064164
commit 856d886241
2 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.rst
View File

@ -13,6 +13,7 @@ Quick links (functional on github. Elsewhere possibly not):
:Github: `<https://github.com/Rogier-5/minetest-mapper-cpp>`_ :Github: `<https://github.com/Rogier-5/minetest-mapper-cpp>`_
:Bugs: `<https://github.com/Rogier-5/minetest-mapper-cpp/issues>`_ :Bugs: `<https://github.com/Rogier-5/minetest-mapper-cpp/issues>`_
:Windows packages: `<https://github.com/Rogier-5/minetest-mapper-cpp/wiki/Downloads>`_ :Windows packages: `<https://github.com/Rogier-5/minetest-mapper-cpp/wiki/Downloads>`_
:Generating colors.txt: `<dumpnodes/README.dumpnodes>`_
Features (short list) Features (short list)
===================== =====================
@ -32,7 +33,8 @@ Map Generation Features
* Draw a scale on the left and/or top side of the map, * Draw a scale on the left and/or top side of the map,
and/or a height scale (for height maps) on the bottom. and/or a height scale (for height maps) on the bottom.
* Optionally draw some nodes transparently (e.g. water) * Optionally draw some nodes transparently (e.g. water)
* User Manual * Includes User Manual
* Includes scripts to aid in generating a color definition file.
Build Features Build Features
-------------- --------------
@ -57,8 +59,9 @@ For more detailed instructions, see `<doc/build-instructions.rst>`_.
**Libraries:** **Libraries:**
* zlib
* libgd * libgd
* sqlite3 * sqlite3 (not mandatory. See `<doc/build-instructions.rst>`_.
* leveldb (if leveldb support is desired) * leveldb (if leveldb support is desired)
* hiredis (if redis support is desired) * hiredis (if redis support is desired)
@ -68,6 +71,9 @@ For more detailed instructions, see `<doc/build-instructions.rst>`_.
* cmake * cmake
* make * make
**Other:**
* python-docutils (if documentation in html format is desired)
Compile Compile
------- -------

10
doc/build-instructions.rst
View File

@ -24,6 +24,7 @@ Requirements
Libraries Libraries
--------- ---------
* zlib
* libgd * libgd
* sqlite3 (optional - enabled by default, set ENABLE_SQLITE3=0 in CMake to disable) * sqlite3 (optional - enabled by default, set ENABLE_SQLITE3=0 in CMake to disable)
* leveldb (optional, set ENABLE_LEVELDB=1 in CMake to enable leveldb support) * leveldb (optional, set ENABLE_LEVELDB=1 in CMake to enable leveldb support)
@ -46,6 +47,13 @@ If converting the documentation to HTML, or another format is desired:
* python-docutils * python-docutils
Packaging
---------
If creation of installation packages is desired:
* fakeroot (for a deb package)
* rpm-build (for an rpm package)
Install Dependencies Install Dependencies
==================== ====================
@ -272,7 +280,7 @@ Conversion to unix man format has acceptable, but not perfect results:
:: ::
cd doc cd doc
rst2html manual.rst > minetestmapper.1 rst2man manual.rst > minetestmapper.1
PDF PDF
--- ---