5640
|
1 If you plan to use gaim CVS, PLEASE read this message in its entirety!
|
|
2
|
|
3 Gaim is a fast-moving project with a regular release schedule. Due to
|
|
4 the rate of gaim development, CVS undergoes frequent bursts of massive
|
|
5 changes, often leaving behind brokenness and partial functionality
|
|
6 while the responsible developers rewrite some portion of code or seek
|
|
7 to add new features.
|
|
8
|
|
9 What this all boils down to is that CVS _WILL_ sometimes be broken.
|
|
10 Because of this, we ask that users who are not interested in
|
|
11 personally tracking down bugs and fixing them (without a lot of
|
|
12 assistance from the developers!) avoid CVS and use releases. Since
|
|
13 releases will be made often, this should not prevent anyone from using
|
|
14 the newest, shiniest features -- but it will prevent users from having
|
|
15 to deal with ugly development bugs that we already know about but
|
|
16 haven't gotten around to fixing.
|
|
17
|
|
18 I you are interested in hacking on gaim, please read README and
|
|
19 HACKING, and take note of the issues in PROGRAMMING_NOTES. (Note that
|
|
20 they may be somewhat out of date at times.) Win32 developers, please
|
|
21 read README.mingw.
|
|
22
|
|
23 By far the best documentation, however, is the documented code. Not
|
|
24 all parts of gaim have yet been documented, but the major subsystems
|
|
25 are falling fast. If you have doxygen, you can use the Doxyfile in
|
|
26 the toplevel directory to generate pretty documentation. Otherwise
|
|
27 (or even if you do!), the header files for each subsystem contain
|
|
28 documentation for the functions they contain. For instance,
|
|
29 conversation.h contains documentation for the entire
|
|
30 gaim_conversation_* API, and account.h contains documentation for the
|
|
31 gaim_account_* API.
|
|
32
|
|
33 If you have questions, please feel free to contact the gaim developers
|
|
34 by email at gaim-devel@lists.sourceforge.net, on IRC at
|
|
35 irc.freenode.net in #gaim, or via the sourceforge forums at
|
|
36 http://www.sourceforge.net/projects/gaim. Please do as much homework
|
|
37 as you can before contacting us; the more you know about your
|
|
38 question, the faster and more effectively we can help you!
|
|
39
|
|
40 Send patches to gaim-devel@lists.sourceforge.net or post them in the
|
|
41 Sourceforge forums at http://www.sourceforge.net/projects/gaim.
|