use gettext for Atom feed
[e-DoKo.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index bed28d57d550e1d9699da6596c206ba39516bff3..886a94d8256a462e161f183acc6c8c84437d5b0f 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,13 +1,17 @@
+
 Installation
 ------------
 
-0) get files
+-1) What you need
+   all you need is PHP and MYSQL. PHP has to include gettext support.
+
+0) Get files
 
-  get all files from 
+  get all files from
 
   http://nubati.net/git/e-DoKo
 
-1) create database
+1) Create database
 
   create a mysql database using the provided file
 
@@ -15,16 +19,21 @@ Installation
 
   use user, password, database and host option of mysql as needed
 
-2) create a config.php file that defines the following variables:
+2) Configure
+
+  Copy config.php_template to config.php and edit it. These variables need to be set:
 
-  $host:  for example "http://localhost/index.php", note: include the index.php here
+  $HOST:  for example "http://localhost"
+  $INDEX: the absolute web path to your index.php file e.g. "/mypath/index.php"
+  $STATS: the absolute web path to your stats.php file e.g. "/mypath/stast.php"
+  $RSSS:  the absolute web path to your rss.php file e.g. "/mypath/rss.php"
 
   database info:
 
-    $DB_host 
-    $DB_user 
-    $DB_password 
-    $DB_database 
+    $DB_host
+    $DB_user
+    $DB_password
+    $DB_database
 
   working on the database:
     in case you need to work on the database for some reason, you can suspend the game
@@ -46,7 +55,10 @@ Installation
        return;
     }
 
+3) install .htaccess: copy htaccess.template to .htaccess and edit it to set RewriteBase.
+   If your site is at http://example.org/~test/edoko you need to set
+   RewriteBase to /~test/edoko
 
-3) log in and enjoy ;)
+4) Log in and enjoy ;)
 
 Arun