diff README @ 616:b90c645dac33

better readme.
author Robert McIntyre <rlm@mit.edu>
date Tue, 26 Feb 2013 11:55:34 +0000
parents bd664a9bd863
children
line wrap: on
line diff
     1.1 --- a/README	Tue Feb 26 11:28:45 2013 +0000
     1.2 +++ b/README	Tue Feb 26 11:55:34 2013 +0000
     1.3 @@ -70,6 +70,33 @@
     1.4  make 
     1.5  make install
     1.6  
     1.7 +To fine tune the installation, pass different flags to the configure
     1.8 +script, in particular the --prefix flag. run `./configure --help` to
     1.9 +see available options and defaults.
    1.10  
    1.11 +* Using the clojure code.
    1.12  
    1.13 +If you're interested in hacking on the clojure code, then once you've
    1.14 +completed the compilation instructions above, you will need to launch
    1.15 +clojure (however you do it) and include the following things on your
    1.16 +classpath (all directories are relative to project root).
    1.17  
    1.18 +/clojure      --- the clojure source files
    1.19 +/java/dist/*  --- JNI bindings
    1.20 +/java/lib/*   --- tritonus libs
    1.21 +
    1.22 +You will also need to put the compiled library file produced from the
    1.23 +"How to Compile" section in a place where it can be loaded as a
    1.24 +dynamic library.  You can do this by running `make install` where you
    1.25 +had previously configured the package to install in a system
    1.26 +directory, or you can use the LD_LIBRARY_PATH to point your system to
    1.27 +the directory containing the library file.
    1.28 +
    1.29 +
    1.30 +* Bugs
    1.31 +
    1.32 +Please let me know if you find any bugs, or have any comments, at
    1.33 +rlm@mit.edu. 
    1.34 +
    1.35 +
    1.36 +