Add the archive functions to the Java library
[loomclient.git] / README
blob9b6bc22c4afb99f63fcb17a61956fc159108ed8c
1 This directory contains Java and PHP libraries for using
2 http://loom.cc/ as a client. The libraries are simple enough that the
3 code should be self-documentating, if you've learned enough about Loom
4 to use them.
6 The PHP library is in the file LoomClient.php. There's an example web
7 form that uses it in grid-tutorial.php. Put those two files in a
8 source directory for a PHP-enabled web server, and aim a browser at
9 grid-tutorial.php, and you'll see it.
11 The Java library is in java/cc/loom/LoomClient.java and as the class
12 cc.loom.LoomClient in loom.jar. You can test it from the command line
13 as follows:
15   java -cp loom.jar cc.loom.LoomClient command arguments...
17 Where command and arguments are docmented by the usage line printed if
18 you just execute:
20   java -cp loom.jar cc.loom.LoomClient
22 The loomclient shell script packages up calling the client so you can
23 say:
25   loomclient command arguments...
27 This is safe to use with real locations, since all communication with
28 loom.cc is done with an encrypted (https) link.
30 The makeloomjar script compiles LoomClient.java and creates
31 loom.jar. It must be run from within this directory.
33 LoomClient.java currently requires Java 5 generics. There is a comment
34 at the top of the file telling you how to change it to work with Java
35 4 (untested).