From 856d886241348101ca9f234cb93f5eb3ae3ddba7 Mon Sep 17 00:00:00 2001 From: Rogier Date: Thu, 26 Nov 2015 17:40:57 +0100 Subject: [PATCH] Some fixes to the documentation --- README.rst | 10 ++++++++-- doc/build-instructions.rst | 10 +++++++++- 2 files changed, 17 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 0c65952..9a2fe67 100644 --- a/README.rst +++ b/README.rst @@ -13,6 +13,7 @@ Quick links (functional on github. Elsewhere possibly not): :Github: ``_ :Bugs: ``_ :Windows packages: ``_ +:Generating colors.txt: ``_ Features (short list) ===================== @@ -32,7 +33,8 @@ Map Generation Features * Draw a scale on the left and/or top side of the map, and/or a height scale (for height maps) on the bottom. * 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 -------------- @@ -57,8 +59,9 @@ For more detailed instructions, see ``_. **Libraries:** +* zlib * libgd -* sqlite3 +* sqlite3 (not mandatory. See ``_. * leveldb (if leveldb support is desired) * hiredis (if redis support is desired) @@ -68,6 +71,9 @@ For more detailed instructions, see ``_. * cmake * make +**Other:** + +* python-docutils (if documentation in html format is desired) Compile ------- diff --git a/doc/build-instructions.rst b/doc/build-instructions.rst index 19651da..6fd5bea 100644 --- a/doc/build-instructions.rst +++ b/doc/build-instructions.rst @@ -24,6 +24,7 @@ Requirements Libraries --------- +* zlib * libgd * 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) @@ -46,6 +47,13 @@ If converting the documentation to HTML, or another format is desired: * python-docutils +Packaging +--------- + +If creation of installation packages is desired: + +* fakeroot (for a deb package) +* rpm-build (for an rpm package) Install Dependencies ==================== @@ -272,7 +280,7 @@ Conversion to unix man format has acceptable, but not perfect results: :: cd doc - rst2html manual.rst > minetestmapper.1 + rst2man manual.rst > minetestmapper.1 PDF ---