git.pond.sub.org Git - empserver/blob - doc/README

   1     Documentation is like sex: when it is good, it is very, very good;
   2     and when it is bad, it is better than nothing.
   3         --- Dick Brandon
   4
   5 These files should be better than nothing:
   6
   7 files
   8         What's where.
   9
  10 backups
  11         Recommendations for how to do backups when running a game.
  12
  13 clients-howto
  14         Material useful for client writers.
  15
  16 troubleshooting
  17         Some common problems and solutions.
  18
  19 configuration
  20         How to turn options on and off, change game parameters, etc...
  21
  22 debugging
  23         Hints on debugging.
  24
  25 econfig
  26         Details about the syntax of data/econfig.
  27
  28 bug-reports
  29         What to do if you find a bug.
  30
  31 threads
  32         Dave Pare explains how lwp threads work.
  33
  34 pthreads
  35         Sasha Mikheev's notes on Empire's threading abstraction, and
  36         its LWP and POSIX threads implementation.
  37
  38 coding
  39         Guidelines for writing Empire code
  40
  41 contributing
  42         How to contribute to Empire
  43
  44 unicode
  45         Design and implementation of Empire's Unicode support.
  46
  47 CHANGES2.0
  48         Detailed revision history for the Empire2 project until
  49         version 2.3.  A more condensed (and much more readable)
  50         version meant for deities and players may be found in "info
  51         Empire2".  For an overview of Empire versions, see "info
  52         History".
  53
  54 CHANGES2.3
  55         Detailed revision history for Empire2 changes since version
  56         2.3, also covered by "info Empire2"
  57
  58 CHANGES3.0
  59         Detailed revision history for Empire3 changes.  The version
  60         meant for deities and players is in "info Empire3".
  61
  62         There is no detailed revision history for versions 4.0.0 to
  63         4.2.12.  Since 4.2.12, detailed history is in the revision
  64         control system, currently Git.  The version meant for deities
  65         and players is in "info Empire4".
  66
  67 WISH_LIST
  68         things which maybe should be coded sometime.
  69
  70 WACKY_IDEAS
  71         things which shouldn't be coded except possibly as an option.