From f1367ecf6edd4ee177c522aa0603e28352621c94 Mon Sep 17 00:00:00 2001
From: "green-ponies (jgen)" <jgen.tech@gmail.com>
Date: Sun, 12 Feb 2012 14:56:21 -0500
Subject: [PATCH] Added some more comments / documentation.

---
 README.txt                  | 11 ++++++++++-
 core/default_config.inc.php | 13 +++++++++++++
 2 files changed, 23 insertions(+), 1 deletion(-)

diff --git a/README.txt b/README.txt
index ea3be20e..b419b692 100644
--- a/README.txt
+++ b/README.txt
@@ -61,6 +61,15 @@ database and file formats haven't changed *completely*, it's different
 enough to be a pain.
 
 
+Custom Configuration
+~~~~~~~~~~~~~~~~~~~~
+
+Various aspects of Shimmie can be configured to suit your site specific
+needs via the file "config.php" (created after installation).
+Take a look at "core/default_config.inc.php" for the available options
+that can used.
+
+
 Development Info
 ~~~~~~~~~~~~~~~~
 http://shimmie.shishnet.org/doc/
@@ -73,7 +82,7 @@ Contact
 ~~~~~~~
 #shimmie on Freenode -- IRC
 webmaster at shishnet.org -- email
-https://github.com/shish/shimmie2 -- bug tracker
+https://github.com/shish/shimmie2/issues -- bug tracker
 
 
 Licence
diff --git a/core/default_config.inc.php b/core/default_config.inc.php
index 2f3003ca..c6a44b57 100644
--- a/core/default_config.inc.php
+++ b/core/default_config.inc.php
@@ -1,4 +1,16 @@
 <?php
+/**
+ * These are the default configuration options for Shimmie.
+ *
+ * All of these can be over-ridden by placing a 'define' in config.php
+ *
+ * Do NOT change them in this file. These are the defaults only!
+ *
+ * Example:
+ *  define("SPEED_HAX", true);
+ *
+ */
+
 // to change these system-level settings, do define("FOO", 123); in config.php
 function _d($name, $value) {if(!defined($name)) define($name, $value);}
 _d("DATABASE_DSN", null);    // string   PDO database connection details
@@ -18,4 +30,5 @@ _d("WH_SPLITS", 1);          // int      how many levels of subfolders to put in
 _d("VERSION", 'trunk');      // string   shimmie version
 _d("SCORE_VERSION", 's2hack/'.VERSION); // string SCore version
 _d("TIMEZONE", null);        // string   timezone
+
 ?>