README.MTN

Mon, 16 Apr 2007 05:34:42 +0000

author
Mark Doliner <markdoliner@pidgin.im>
date
Mon, 16 Apr 2007 05:34:42 +0000
changeset 16269
603d1a8e8333
parent 16128
README.SVN@af6d46e5199a
parent 16239
README.SVN@768032ce3f66
child 16317
6723cbdbc816
permissions
-rw-r--r--

merge of '75e206eda5a2d8987935e703d0f27ab7b36f2352'
and '79af428b8eb6657b57ccb257dce5c95381e04743'

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

mercurial