Mercurial > pidgin.yaz
comparison README.MTN @ 16176:83ec0b408926
Beat some older documentation into submission.
author | Richard Laager <rlaager@wiktel.com> |
---|---|
date | Sun, 15 Apr 2007 23:26:37 +0000 |
parents | |
children | e0bcb8cfda74 |
comparison
equal
deleted
inserted
replaced
16175:4493d6de6384 | 16176:83ec0b408926 |
---|---|
1 If you plan to use Pidgin, Finch and libpurple from our Monotone repository, | |
2 PLEASE read this message in its entirety! | |
3 | |
4 Pidgin, Finch, and libpurple are a fast-moving project with a somewhat regular | |
5 release schedule. Due to the rate of development, the code in our Monotone | |
6 repository undergoes frequent bursts of massive changes, often leaving behind | |
7 brokenness and partial functionality while the responsible developers rewrite | |
8 some portion of code or seek to add new features. | |
9 | |
10 What this all boils down to is that the code in our Monotone repository _WILL_ | |
11 sometimes be broken. Because of this, we ask that users who are not interested | |
12 in personally tracking down bugs and fixing them (without a lot of | |
13 assistance from the developers!) use only released versions. Since releases | |
14 will be made often, this should not prevent anyone from using the newest, | |
15 shiniest features -- but it will prevent users from having to deal with ugly | |
16 development bugs that we already know about but haven't gotten around to fixing. | |
17 | |
18 If you are interested in hacking on Pidgin, Finch, and/or libpurple, please | |
19 check out the information available at: http://developer.pidgin.im | |
20 | |
21 By far the best documentation, however, is the documented code. If you have | |
22 doxygen, you can run "make docs" in the toplevel directory to generate pretty | |
23 documentation. Otherwise (or even if you do!), the header files for each | |
24 subsystem contain documentation for the functions they contain. For instance, | |
25 conversation.h contains documentation for the entire purple_conversation_* | |
26 API, and account.h contains documentation for the purple_account_* API. | |
27 | |
28 If you have questions, please feel free to contact the Pidgin, Finch, and | |
29 libpurple developers by e-mail at devel@pidgin.im or on IRC at irc.freenode.net | |
30 in #pidgin. Please do as much homework as you can before contacting us; the | |
31 more you know about your question, the faster and more effectively we can help! | |
32 | |
33 Patches should be posted as Trac tickets at: http://developer.pidgin.im |