X-Git-Url: http://dolda2000.com/gitweb/?p=doldaconnect.git;a=blobdiff_plain;f=README;h=427ed00fd5b7c1f8b946a583e2ff2661696f4e4e;hp=ff87fb84c63cfb44c139cb30b899e48e1b0bb413;hb=HEAD;hpb=416ada5c6de59537724589a0810a0bd151b28b03 diff --git a/README b/README index ff87fb8..427ed00 100644 --- a/README +++ b/README @@ -17,7 +17,10 @@ file-sharing work, and a number of client programs that connect to the server in order to command it and display its status. The interaction between the client and server is carried out using a well-defined protocol, making it fairly easy to write new clients for specialized -tasks. +tasks. It is worthy of note that the default configuration file +disables running clients over the network, for convenience of +setup. See the INSTALL file for details and instructions on how to +enabled networked clients. To make it easier to write new clients, a C library has been written to make common functions easier, such as connecting, authenticating, @@ -39,27 +42,29 @@ tree: client program. * A GNOME panel applet for showing the status of current downloads in progress. - * A Gaim chat plugin for chatting in hubs and writing private + * A Gaim/Pidgin chat plugin for chatting in hubs and writing private messages (only for Gaim 2.0.0 and above). * A command-line automatic downloader written in Scheme. * A chat logger written in Scheme. * A hub manager written in Scheme. -The GNOME applet and Gaim plugin are somewhat experimental. The applet -seems to be working well, but the installation have some quirks (since -GNOME does not normally look in /usr/local, care must be taken with -the installation prefix). The Gaim plugin seems to be leaking some -memory. +The GNOME applet and Gaim plugin are somewhat experimental. Both work +fairly well, but they do require special care during installation, +since neither GNOME nor Gaim/Pidgin usually look for applets/plugins +in the directories where Dolda Connect gets installed by default. See +the files doc/INSTALL.applet and doc/INSTALL.gaim for further details. Installation -See the INSTALL file. +See the doc/INSTALL file. Documentation -Documentation is still spotty at best. For any information not found -in the README or INSTALL files (or the source code, if you are a -programmer), contact the author. +Documentation is still rather weak, but it is getting better. Besides +the README and INSTALL* files, there are now manpages for a number of +the constituent programs. For any information still not found, please +do not hesitate to contact the author. Any further documentation aside +from this README file is located in the `doc' directory. Credits @@ -69,5 +74,5 @@ through the e-mail address . His homepage is -This documented was last updated 2007-04-11, reflecting release 0.3 of +This document was last updated 2008-02-14, reflecting release 1.1 of Dolda Connect.