diff Readme.txt @ 56:f9f5e04f20b2

Bit of polish for a public release, including some more documentation.
author Diggory Hardy <diggory.hardy@gmail.com>
date Sat, 14 Jun 2008 12:04:25 +0100
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Readme.txt	Sat Jun 14 12:04:25 2008 +0100
@@ -0,0 +1,17 @@
+See doc/Readme.txt for the real readme. This file just lists some quick information about what's here...
+
+mde/            The source directory.
+data/           Some data files, plus some base configuration data (user-
+                configuration should be stored in ~/.config/mde on UNIX systems
+                and ./user on Windows (needs fixing); see
+                codeDoc/resource/paths.txt for further info).
+user/           Windows only user-config (see above note).
+bin/            This directory contains executables/other binaries. It must
+                exist for compiling (but should be auto-created).
+doc/            Some basic information.
+codeDoc/        Documentation aimed mostly at developers. The directory
+                structure roughly corresponds to that under mde/.
+test/           Source code for testing programs.
+util/           Source code for utility programs.
+dsss_objs/      Compiled object files. Delete if you like.
+dsss.conf       The build-time configuration.