|
16067
|
1 If you plan to use Pidgin, Finch & libpurple mtn, PLEASE read this message in its entirety!
|
|
13632
|
2
|
|
16067
|
3 Pidgin, Finch & libpurple is a fast-moving project with a somewhat regular
|
|
|
4 release schedule. Due to the rate of Pidgin, Finch & libpurple development,
|
|
|
5 mtn undergoes frequent bursts of massive changes, often leaving behind
|
|
|
6 brokenness and partial functionality while the responsible developers rewrite
|
|
|
7 some portion of code or seek to add new features.
|
|
13632
|
8
|
|
16067
|
9 What this all boils down to is that mtn _WILL_ sometimes be broken.
|
|
13632
|
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
|
|
16067
|
12 assistance from the developers!) avoid mtn and use releases. Since
|
|
13632
|
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
|
|
16067
|
18 If you are interested in hacking on Pidgin, Finch & libpurple, please read
|
|
|
19 README and HACKING, and take note of the issues in PROGRAMMING_NOTES. (Note
|
|
|
20 that they may be somewhat out of date at times.) Win32 developers, please
|
|
13632
|
21 read README.mingw.
|
|
|
22
|
|
|
23 By far the best documentation, however, is the documented code. Not
|
|
16067
|
24 all parts of Pidgin, Finch & libpurple have yet been documented, but the major
|
|
|
25 subsystems are falling fast. If you have doxygen, you can use the Doxyfile in
|
|
13632
|
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,
|
|
16067
|
29 conversation.h contains documentation for the entire purple_conversation_*
|
|
|
30 API, and account.h contains documentation for the purple_account_* API.
|
|
13632
|
31
|
|
16067
|
32 If you have questions, please feel free to contact the Pidgin, Finch &
|
|
|
33 libpurple developers by email at devel@pidgin.im or on IRC at irc.freenode.net
|
|
|
34 in #pidgin. Please do as much homework as you can before contacting us; the
|
|
|
35 more you know about your question, the faster and more effectively we can help
|
|
|
36 you!
|
|
13632
|
37
|
|
16067
|
38 Send patches to Pidgin, Finch & libpurple mailing list, devel@pidgin.im, or
|
|
|
39 post them in the tracker at http://developer.pidgin.im.
|
