Added some more comments / documentation.

This commit is contained in:
green-ponies (jgen) 2012-02-12 14:56:21 -05:00
parent edf5059ef4
commit f1367ecf6e
2 changed files with 23 additions and 1 deletions

View file

@ -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

View file

@ -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
?>