[gaim-migrate @ 2328]

documentation updates.

6 files changed, 53 insertions, 79 deletions

diff --git a/AUTHORS b/AUTHORS
index 01d91f5c11..ec2cede42e 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -17,6 +17,7 @@ Eric Warmenhoven <warmenhoven@yahoo.com> - Second in Command (patches here too)
 	Jabber: warmenhoven@jabber.org
 Syd Logan - Hacker and Designated Driver (lazy bum)
 
+We've got an IRC room now too, #gaim on irc.openprojects.net. Come check us out.
 
 Retired:
 --------
diff --git a/ChangeLog b/ChangeLog
index 8a5f77f8c8..3e3b3fabef 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,6 +1,6 @@
 GAIM: The Pimpin' Penguin IM Clone thats good for the soul! 
 
-version 0.44:
+version 0.44 (09/20/2001):
 	* More sane scaling of buddy icons (intelligently scale to
 	  either 48x48 or 50x50 depending on icon)
 	* Have you ever had it happen where you cancel a login and
diff --git a/PRPL b/PRPL
index 216e6325c7..bec179971c 100644
--- a/PRPL
+++ b/PRPL
@@ -50,39 +50,20 @@ Erg. Now the fun part. The part that you would have never guessed if you
 weren't me. (I know that you wouldn't have guessed this stuff because
 it isn't painfully obvious to me. Use the Source, Luke.)
 
-Let's start with the basics. PRPLs shouldn't use GTK at all. That said,
-they have to in no fewer than three functions: action_menu, user_opts, and
-draw_new_user (probably do_new_user too). Fortunately, all of these are
-optional. Unfortunatly, all of these are so incredibly useful that they
-probably aren't optional.  If you use GTK (other than gdk_input_add/remove
-for the connections) in any function other than these three I will hunt
-you down like the dog you are and kill you. (Oscar and TOC are excused
-temporarily because they existed long before all the other PRPLs.)
+Let's start with the basics. PRPLs shouldn't use GTK at all. If you use
+GTK I will hunt you down like the dog you are and kill you.
 
 You're probably wondering how you can do certain things without GTK. Well,
 you're just going to have to make do. Rely on the UI, that's why it's
 there.	A PRPL should have absolutely ZERO interaction with the user,
-it should all be handled by the UI. So far, about the only thing that's
-been added to gaim to aid in this goal is do_ask_dialog. But at least
-it's a start.
-
-do_ask_dialogs is one of the worst creations ever to come from my ass. It
-must have been very late in the morning, just before I went to sleep,
-when I coded it. That's my excuse.
-
-You pass it the question you want to ask, what to do on Yes, what to
-do on No, and optional data. The logic actually isn't like that at
-all. Given you call do_ask_dialog("Wanna?", mydata, yes_func, no_func),
-the logic is:
-
-if (clicked_yes)
-	yes_func();
-no_func();
-
-i.e. no_func() gets called regardless of what's clicked. So
-it's best to use it for freeing mydata, and not freeing mydata in
-yes_func. To be quite honest, I'm not sure no_func is needed. (I
-also seem to think that yes_func isn't entirely necessary either,
-except for the little part about it being the point of do_ask_dialog.)
-
-Um. So that was interesting.
+it should all be handled by the UI.
+
+So let's talk about what that means in a practical way. Have a socket that
+you want notification on? Use gaim_input functions; they work just like
+the gdk_input functions. Want to add a timeout? g_timeout_add and
+g_source_remove. Want to ask a question? do_ask_dialog. Etc.
+
+Don't use the _options variables at all. The core should take care of all
+of that.
+
+Um. I'm sure there's more.
diff --git a/README b/README
index 42fa582918..f7d8b3103a 100644
--- a/README
+++ b/README
@@ -6,7 +6,7 @@ Syd Logan - Super Hacker and Resident Designated Driver
 Jim Duchek <jimduchek@ou.edu> IM: Zilding (former maintainer)
 Mark Spencer <markster@marko.net>
 
-Build:
+* Build:
 
 ./configure ; make 
 for the stock version.  ./configure --help to see what option you can get.
@@ -24,7 +24,7 @@ If you want to build as a GNOME applet:
 then su to root and run "make install". 
 Afterwards panel->Add applet->Network->Gaim should be there.
 
-Run:
+* Run:
 
 type "./gaim"
 
@@ -42,7 +42,19 @@ global proxy configuration; however, if you have the proxy set to use a
 SOCKS5 proxy, ICQ will use it. If the proxy options aren't robust enough
 for you there are several libraries that you can link gaim against.
 
-Notes:
+* Plugins:
+
+If you do not wish to enable the plugin support within GAIM, run the
+./configure script with the --disable-plugins option and recompile your
+source code.  This will prevent the ability to load plugins.
+
+'make install' puts the plugins in $PREFIX/lib/gaim (PREFIX being what you
+specified when you ./configure'd - it defaults to /usr/local). Gaim looks
+for the plugins in that directory by default, but they do not have to be
+there to use them. Also, plugins have a .so extension by default, though
+they do not have to.
+
+* Notes:
 
 This should now compile under Solaris, Digital Unix, Irix, etc w/o a
 problem.
@@ -63,4 +75,3 @@ sourceforge page at http://sourceforge.net/projects/gaim/
 
 Keep your eyes out for updates, and I'll try to keep the program maintained.
 Other contributors and patches are welcomed.  Please read the FAQ first.
-
diff --git a/README.plugins b/README.plugins
deleted file mode 100644
index cd9e1c16a0..0000000000
--- a/README.plugins
+++ /dev/null
@@ -1,16 +0,0 @@
-Note:
-
-If you do not wish to enable the plugin support within GAIM, run the
-./configure script with the --disable-plugins option and recompile your
-source code.  This will prevent the ability to load plugins.
-
-'make install' puts the plugins in $PREFIX/lib/gaim (PREFIX being what you
-specified when you ./configure'd - it defaults to /usr/local). Gaim looks
-for the plugins in that directory by default, but they do not have to be
-there to use them. Also, plugins have a .so extension by default, though
-they do not have to.
-
-Enjoy and Happy Hacking!
-
-Rob Flynn
-
diff --git a/STATUS b/STATUS
index 224e0d454f..e5a856116b 100644
--- a/STATUS
+++ b/STATUS
@@ -1,4 +1,4 @@
-STATUS of GAIM CVS tree. Last modified $Date: 2001-05-23 07:39:05 -0400 (Wed, 23 May 2001) $ by
+STATUS of GAIM CVS tree. Last modified $Date: 2001-09-20 04:13:25 -0400 (Thu, 20 Sep 2001) $ by
 $Author: warmenhoven $.
 
 This file is meant to provide gaim users who use the CVS version to see whether
@@ -6,6 +6,15 @@ they actually want to compile what they just checked out. Gaim CVS is usually
 relatively stable (we use it all the time), but has tendencies to be quirky at
 times.
 
+There always seems to be some iffy-ness by a lot of people about whether to
+use the CVS version or stick with a stable release. Use the CVS version. If
+you need a version that you know is reliable, then keep your favorite one in
+case of an emergency. But for the most part, gaim is not mission-critical
+software, and if you can help us find a few bugs before we release, all the
+better. (Also, CVS tends to be more stable than releases, since we get 10 or
+12 bug reports right after we make a release, and all those bugs are fixed
+within a day or two usually.)
+
 Each protocol is hacked by both Rob and Eric, though there is one person that
 kind of "owns" a protocol (mostly indicating that they were the person that
 originally wrote it). Their name will be next to the protocol; they're the
@@ -15,21 +24,10 @@ people to complain to when something doesn't work ;).
 OVERALL
 =======
 
-The current CVS tree is more or less back to "normal". It seems to be stable,
-and allows multiple connections (which should also be stable).
-
-There have been a lot of changes since 0.10.x; I think all of the bugs have
-been worked out but I'm sure there are still a lot remaining. Please, if you
-get bored one day, go on a big bug hunt.
-
-There always seems to be some iffy-ness by a lot of people about whether to
-use the CVS version or stick with a stable release. Use the CVS version. If
-you need a version that you know is reliable, then keep your favorite one in
-case of an emergency. But for the most part, gaim is not mission-critical
-software, and if you can help us find a few bugs before we release, all the
-better. (Also, CVS tends to be more stable than releases, since we get 10 or
-12 bug reports right after we make a release, and all those bugs are fixed
-within a day or two usually.)
+Everything right now is more or less peachy. I regularly use seven protocols
+at the same time and don't have any problems (all of them except Napster and
+Zephyr). You shouldn't be using 0.10.3; there are serious bugs in it (including
+a remote exploit). Always use CVS, or if not, the most recent release.
 
 
 Buddy List
@@ -59,9 +57,9 @@ every plugin is going to need to be rewritten.  Have fun porting from 0.10.x to
 Perl
 ====
 
-Perl also got a good reworking, but also has a few more features now. Again,
-porting from 0.10.x to 0.11.0 should be simple, but read the docs to see what's
-going on.
+Perl has its good side and bad side. It didn't completely survive the transition
+to multiple connections, but it was never really intended for more than a chatbot
+anyway, which should still work just wonderfully.
 
 
 TOC (Rob)
@@ -104,21 +102,20 @@ probably not my fault. Make sure to watch the debug window if you're having any
 problems.
 
 
-IRC (Rob)
+IRC (Eric)
 ===
 
 IRC currently supports signing on/off, sending and receiving messages,
 joining chat rooms and holding conversations within them.  The buddylist
-also works and users have the ability to send ping requests to the user
-by right clicking their name.  /me support is also added.  Other commands
-and functionality are planned but not yet implemented.
+also works. Several /commands work as well, /help in any window will show
+you a full list.
 
 
-MSN (Rob)
+MSN (Eric)
 ===
 
-MSN currently supports signing on/off, sending and receiving messages, adding
-and removing people to your permit/deny list and going away / idle.
+MSN currently supports signing on/off, sending and receiving messages, and going
+away/idle. You can also change your friendly name.
 
 
 ICQ (Eric)