README.CVS

Sun, 20 Jul 2003 18:59:56 +0000

author
Björn Voigt <bjoern@cs.tu-berlin.de>
date
Sun, 20 Jul 2003 18:59:56 +0000
changeset 6246
f196b660af4f
parent 5640
cd9873560d20
child 6797
5fb5c29d8fed
permissions
-rw-r--r--

[gaim-migrate @ 6740]
Lots of very minor updates:
-dos2unixed PROGRAMMING_NOTES
-added PROGRAMMING_NOTES to make dist, or whatever
-fixed a typo in README.CVS
-updated the version number
-sheared the sheep
-rpm spec file updates from Bjoern Voigt

committer: Mark Doliner <markdoliner@pidgin.im>

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

mercurial