annotate README.CVS @ 6078:87714ede9264

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