annotate README.SVN @ 19802:4a832e480178

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