README.SVN

Sun, 15 Apr 2007 18:13:53 +0000

author
Richard Laager <rlaager@pidgin.im>
date
Sun, 15 Apr 2007 18:13:53 +0000
changeset 16206
113ec06e6e1d
parent 16128
af6d46e5199a
permissions
-rw-r--r--

The .service files for libpurple aren't necessary. Their only purpose is to
autostart an application if nothing is listening in a particular namespace. We
can't autostart something, because there's no way for us to know which client
the user wants. If we end up with Pidgin or Finch DBus stuff later, we can
use .service files for those if we want autostart functionality.

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

mercurial