X-Git-Url: http://git.dolda2000.com/gitweb/?a=blobdiff_plain;f=README;h=171ea3697e966e41bdeaf032481e377765e690e0;hb=2f3d928fe3b9ce15ebe62aae6dda48da868260c1;hp=87f27907143dd12cd71e2cf335e37d9034067211;hpb=a56bedc9d266ab4b8f569be6cbdf97b36a27f037;p=doldaconnect.git diff --git a/README b/README index 87f2790..171ea36 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,7 +35,7 @@ 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 @@ -40,22 +43,27 @@ tree: * 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. + 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 installation prefix). The Gaim plugin seems to be leaking some +memory. Installation See the 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. + Credits Dolda Connect is primarily written by Fredrik Tolf. He can be reached @@ -64,5 +72,5 @@ through the e-mail address . His homepage is -This documented was last updated 2006-06-24, reflecting release 0.1 of +This documented was last updated 2007-04-11, reflecting release 0.3 of Dolda Connect.