From 49a22e129187e97e650e76d14632365d26144bdc Mon Sep 17 00:00:00 2001
From: Perttu Ahola <celeron55@gmail.com>
Date: Sat, 21 May 2011 11:31:48 +0300
Subject: [PATCH] some documentation updates

---
 doc/README.txt        |  7 ++++++
 minetest.conf.example | 58 ++++++++++++++++++++++++++++++++++---------
 2 files changed, 53 insertions(+), 12 deletions(-)

diff --git a/doc/README.txt b/doc/README.txt
index 12e58e457..d1d178d77 100644
--- a/doc/README.txt
+++ b/doc/README.txt
@@ -3,6 +3,12 @@ Minetest-c55
 An InfiniMiner/Minecraft inspired game.
 Copyright (c) 2010-2011 Perttu Ahola <celeron55@gmail.com>
 
+Further documentation:
+----------------------
+- Website: http://celeron.55.lt/~celeron55/minetest/
+- Wiki: http://celeron.55.lt/~celeron55/minetest/wiki/
+- Forum: http://celeron.55.lt/~celeron55/minetest/forum/
+
 This is a development version:
 ------------------------------
 - Don't expect it to work as well as a finished game will.
@@ -12,6 +18,7 @@ This is a development version:
 Controls:
 ---------
 - See the in-game pause menu
+- Settable in the configuration file, see the section below.
 
 Map directory:
 --------------
diff --git a/minetest.conf.example b/minetest.conf.example
index 4a2c491b0..9804370bf 100644
--- a/minetest.conf.example
+++ b/minetest.conf.example
@@ -6,11 +6,29 @@
 #
 # By default, all the settings are commented and not functional.
 # Uncomment settings by removing the preceding #.
+#
+# Further documentation:
+# http://celeron.55.lt/~celeron55/minetest/wiki/doku.php
 
 #
 # Client side stuff
 #
 
+# Initial window size
+#screenW = 800
+#screenH = 600
+
+# Port to connect to and to bind a server at
+#port = 30000
+
+# Address to connect to (blank = start local server)
+#address = 
+
+# Name of player. On server, this is the default admin.
+#name = 
+
+# Key configuration.
+# See http://irrlicht.sourceforge.net/docu/namespaceirr.html#a54da2a0e231901735e3da1b0edf72eb3
 #keymap_forward = KEY_KEY_W
 #keymap_backward = KEY_KEY_S
 #keymap_left = KEY_KEY_A
@@ -20,39 +38,52 @@
 #keymap_inventory = KEY_KEY_I
 #keymap_chat = KEY_KEY_T
 #keymap_rangeselect = KEY_KEY_R
-# Some (temporary) keys for debugging
+# Some (temporary) keys for debugging features
 #keymap_special1 = KEY_KEY_E
 #keymap_print_debug_stacks = KEY_KEY_P
 
+# The desired FPS
 #wanted_fps = 30
+
+# If FPS would go higher than this, limit it by sleeping
+# (to not waste CPU power for no benefit)
 #fps_max = 60
+
+# The allowed adjustment range for the automatic rendering range adjustment
 #viewing_range_nodes_max = 300
 #viewing_range_nodes_min = 35
-#screenW = 800
-#screenH = 600
-#port = 30000
-#address = 
-#name = 
 
-# Whether to try to fog out the border of the visible area
+# Whether to fog out the end of the visible area
 #enable_fog = true
+
 # Enable a bit lower water surface; disable for speed
 #new_style_water = true
+
 # Enable nice leaves; disable for speed
 #new_style_leaves = true
-# Enable smooth lighting with simple ambient occlusion; disable for speed
+
+# Enable smooth lighting with simple ambient occlusion;
+# disable for speed or for different looks.
 #smooth_lighting = true
-# Whether to draw a frametime graph
+
+# Whether to draw a frametime graph (for debugging frametime)
 #frametime_graph = false
-# Enable combining mainly used textures to a bigger one
+
+# Enable combining mainly used textures to a bigger one for improved speed
+# disable if it causes graphics glitches.
 #enable_texture_atlas = true
-# Path to texture directory
+
+# Path to texture directory. All textures are first searched from here.
 #texture_path =
+
+# Video back-end.
 # Possible values: null, software, burningsvideo, direct3d8, direct3d9, opengl
 #video_driver = opengl
 
-# 
+# Enable random user input, for testing
 #random_input = false
+
+# Timeout for client to remove unused map data from memory
 #client_delete_unused_sectors_timeout = 1200
 
 #
@@ -60,8 +91,10 @@
 #
 
 # Set to true to enable experimental features
+# (varies from version to version, see wiki)
 #enable_experimental = false
 
+# Map directory (everything in the world is stored here)
 #map-dir = /home/palle/custom_map
 
 # Set to true to enable creative mode (unlimited inventory)
@@ -69,6 +102,7 @@
 
 #enable_damage = false
 
+# Gives some stuff to players at the beginning
 #give_initial_stuff = false
 
 # Player and object positions are sent at intervals specified by this
-- 
2.25.1