diff README.txt @ 23:070a9ced4d3e

Add README, put some new links on several pages.
author John "Elwin" Edwards
date Sat, 05 Oct 2013 17:10:24 -0700
parents
children ce26225f7d9d
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.txt	Sat Oct 05 17:10:24 2013 -0700
@@ -0,0 +1,17 @@
+RLG: various files used by the Roguelike Gallery.
+
+dgl/ contains the Gallery's dgamelaunch.conf file, the dgamelaunch menus, and 
+a patch to dgamelaunch 1.5.1 which makes it compatible with the RLGWebD 
+player.
+
+py/ contains various Python scripts.
+
+py/recorder.py processes the log files and stores the data in a PostgreSQL
+database.  It should be run periodically by cron.
+
+py/rlgalldb.py is a module which recorder.py requires.  It should be installed
+in /lib/python<x.y>/site-packages or the equivalent location.
+
+web/ contains the static parts of the rlgallery.org website.  Note that when 
+installed, scoring/ needs to be writable by whatever user is running the 
+recorder.py script.