]> git.pond.sub.org Git - empserver/blob - doc/README
doc/contributing: New file
[empserver] / 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 coding style
40
41 contributing
42         How to contribute to Empire
43
44 unicode
45         Design and implementation of Empire's Unicode support.
46
47 CHANGES
48         Revision history for all the changes that were coded in the Empire2
49         project.  A much more readable version of this may be found in
50         "info History" (brief) or "info Empire2" (detailed).
51
52 CHANGES2.3
53         All changes since revision 2.3
54
55 CHANGES3.0
56         All changes since revision 3.0
57
58 CHANGES4.X
59         All changes since revision 4.0
60
61 WISH_LIST
62         things which maybe should be coded sometime.
63
64 WACKY_IDEAS
65         things which shouldn't be coded except possibly as an option.