view README.CVS @ 8999:8f838ae3e710

[gaim-migrate @ 9774] " This patch renames the existing received-*-msg signals to receiving-*msg to fit the naming of other signals where a pointer to the message is passed (writing, sending, displaying) It adds new received-*-msg signals which are emitted after the receiving signals, in line with the other conversation signals (wrote, sent, displayed) This is necessary to allow plugins which depend on the final received message to work alongside plugins which may modify the message. One known example of this is festival-gaim alongside gaim-encryption - festival-gaim would try to "speak" the encrypted text: http://sf.net/tracker/?func=detail&aid=943216&group_id=89763&atid=591320 I've tested this with gaim-encryption and festival-gaim (locally modified so gaim-encryption uses the receiving signal and festival uses the received signal) All in-tree users of received-*-msg are updated to use receiving-*-msg if they do modify the message, the conversation-signals documentation is updated, the signals-test.c & signal-test.tcl plugins are also updated." --Stu Tomlinson committer: Tailor Script <[e-mail]>

If you plan to use gaim CVS, PLEASE read this message in its entirety!

Gaim is a fast-moving project with a somewhat regular release schedule.  
Due to the rate of gaim development, CVS undergoes frequent bursts of 
massive changes, often leaving behind brokenness and partial 
functionality while the responsible developers rewrite some portion of 
code or seek to add new features.

What this all boils down to is that CVS _WILL_ sometimes be broken.
Because of this, we ask that users who are not interested in
personally tracking down bugs and fixing them (without a lot of
assistance from the developers!) avoid CVS and use releases.  Since
releases will be made often, this should not prevent anyone from using
the newest, shiniest features -- but it will prevent users from having
to deal with ugly development bugs that we already know about but
haven't gotten around to fixing.

If you are interested in hacking on gaim, please read README and
HACKING, and take note of the issues in PROGRAMMING_NOTES.  (Note that
they may be somewhat out of date at times.) Win32 developers, please
read README.mingw.

By far the best documentation, however, is the documented code.  Not
all parts of gaim have yet been documented, but the major subsystems
are falling fast.  If you have doxygen, you can use the Doxyfile in
the toplevel directory to generate pretty documentation.  Otherwise
(or even if you do!), the header files for each subsystem contain
documentation for the functions they contain.  For instance,
conversation.h contains documentation for the entire
gaim_conversation_* API, and account.h contains documentation for the
gaim_account_* API.

If you have questions, please feel free to contact the gaim developers
by email at [e-mail], on IRC at
irc.freenode.net in #gaim, or via the sourceforge forums at
http://www.sourceforge.net/projects/gaim.  Please do as much homework
as you can before contacting us; the more you know about your
question, the faster and more effectively we can help you!

Send patches to [e-mail] or post them in the
Sourceforge forums at http://www.sourceforge.net/projects/gaim.