Link to Trubanc 1.0b1 announcement
[loomclient.git] / README
blob294100ea0e51a9935f7ae3e8cd456137f9b92b94
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. They require the files:
8 Diceware.php, LoomRandom.php, and bcbitwise.php. Put those files in a
9 source directory for a PHP-enabled web server, and aim a browser at
10 grid-tutorial.php, and you'll see the tutorial.
12 The Java library is in java/cc/loom/LoomClient.java and as the class
13 cc.loom.LoomClient in loom.jar. You can test it from the command line
14 as follows:
16   java -cp loom.jar cc.loom.LoomClient command arguments...
18 Where command and arguments are docmented by the usage line printed if
19 you just execute:
21   java -cp loom.jar cc.loom.LoomClient
23 The loomclient shell script packages up calling the client so you can
24 say:
26   loomclient command arguments...
28 This is safe to use with real locations, since all communication with
29 loom.cc is done with an encrypted (https) link.
31 The makeloomjar script compiles LoomClient.java and creates
32 loom.jar. It must be run from within this directory.
34 LoomClient.java currently requires Java 5 generics. There is a comment
35 at the top of the file telling you how to change it to work with Java
36 4 (untested).