X-Git-Url: http://dolda2000.com/gitweb/?p=doldaconnect.git;a=blobdiff_plain;f=README;h=427ed00fd5b7c1f8b946a583e2ff2661696f4e4e;hp=87f27907143dd12cd71e2cf335e37d9034067211;hb=HEAD;hpb=a56bedc9d266ab4b8f569be6cbdf97b36a27f037 diff --git a/README b/README index 87f2790..427ed00 100644 --- a/README +++ b/README @@ -17,13 +17,16 @@ 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, sending requests and parsing the responses. The C library also has a wrapper module for GNU Guile, so that clients can be written in -Scheme. +Scheme. As of 0.3, there is also a Python module available seperately. None of these are documented (yet), but there are a number of examples scattered around the source tree, so it should not be awfully hard to @@ -32,29 +35,36 @@ author. Clients -So far, the following clients are distributet along with the source +So far, the following clients are distributed along with the source tree: * A Gtk2 based GUI, which loosely resembles a normal Direct Connect 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 - messages. + * 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 has some performance issues -and seems to be leaking some memory. The performance problems lie in -Gaim itself, however, and the Gaim developers have indicated that they -will be fixed in Gaim 2.0.0. +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 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 @@ -64,5 +74,5 @@ through the e-mail address . His homepage is -This documented was last updated 2006-06-24, reflecting release 0.1 of +This document was last updated 2008-02-14, reflecting release 1.1 of Dolda Connect.