changeset 16067:361c15e0b320

some doc changes
author Luke Schierer <lschiere@pidgin.im>
date Wed, 11 Apr 2007 18:02:18 +0000
parents b5118ddf37c2
children 5e436cd088e4
files README.SVN TODO
diffstat 2 files changed, 25 insertions(+), 33 deletions(-) [+]
line wrap: on
line diff
--- a/README.SVN	Wed Apr 11 17:46:01 2007 +0000
+++ b/README.SVN	Wed Apr 11 18:02:18 2007 +0000
@@ -1,41 +1,39 @@
-If you plan to use gaim SVN, PLEASE read this message in its entirety!
+If you plan to use Pidgin, Finch & libpurple mtn, 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, SVN 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.
+Pidgin, Finch & libpurple is a fast-moving project with a somewhat regular
+release schedule. Due to the rate of Pidgin, Finch & libpurple development,
+mtn 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 SVN _WILL_ sometimes be broken.
+What this all boils down to is that mtn _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 SVN and use releases.  Since
+assistance from the developers!) avoid mtn 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
+If you are interested in hacking on Pidgin, Finch & libpurple, 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
+all parts of Pidgin, Finch & libpurple 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.
+conversation.h contains documentation for the entire purple_conversation_*
+API, and account.h contains documentation for the purple_account_* API.
 
-If you have questions, please feel free to contact the gaim developers
-by email at gaim-devel@lists.sourceforge.net, 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!
+If you have questions, please feel free to contact the Pidgin, Finch &
+libpurple developers by email at devel@pidgin.im or on IRC at irc.freenode.net
+in #pidgin.  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 gaim-devel@lists.sourceforge.net or post them in the
-Sourceforge forums at http://www.sourceforge.net/projects/gaim.
+Send patches to Pidgin, Finch & libpurple mailing list, devel@pidgin.im, or
+post them in the tracker at http://developer.pidgin.im.
--- a/TODO	Wed Apr 11 17:46:01 2007 +0000
+++ b/TODO	Wed Apr 11 18:02:18 2007 +0000
@@ -26,7 +26,7 @@
 }}}
 * buddy list {{{
 	* we have not committed any gobjectification, so this is not a blocker for 2.0.0 until we do.
-		* if we do, it is only a blocker to the extent that gaim needs to run.  That is, we do not
+		* if we do, it is only a blocker to the extent that pidgin & finch need to run.  That is, we do not
 		  *necessarily* have to gobjectifiy everything as long as we preserve functionality.
 		* That being said, my understanding of the signals mess says that it is probly more work to
 		  try to do this in stages than to start it or not start it.
@@ -40,12 +40,6 @@
 	* bugs
 		* wrong buddy given priority
 }}}
-* build targets {{{
-  * this is not a blocker
-  * we need build targets for libgaim, we need to test them, and make sure they work.
-  * we ought to use our own build targets to build the executable itself.
-  * due to the limitations of cvs, this cannot accompany moving files to other directories at this time.
-}}}
 * status {{{
 	* Error messages aren't particularly usable currently.  we need to be able to see the full text of
 	  the error, and what account is in that error condition.
@@ -74,9 +68,9 @@
 	* on upgrade from 1.x, the timestamp preference often gets lost.
 }}}
 * system log {{{
-	* The system log minimally should tell me what _I_ do in gaim.  It should (minimally) tell me about
+	* The system log minimally should tell me what _I_ do in Pidgin.  It should (minimally) tell me about
 	  my accounts and actions.  It should thus list
-	  * gaim start and quit
+	  * Pidgin start and quit
 	  * Account connection
 	  * account disconnection, and reason if caused by error.
 	  * account state changes, IFF we are logging that for buddies.