1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README	Tue Feb 26 11:28:45 2013 +0000
     1.3 @@ -0,0 +1,75 @@
     1.4 +This is vba-clojure, by Robert McIntyre (rlm@mit.edu).
     1.5 +
     1.6 +It is three things:
     1.7 +
     1.8 + - vba-rerecording (http://code.google.com/p/vba-rerecording/),
     1.9 +   modified compile on GNU/Linux, as well as JNI bindings.
    1.10 +
    1.11 + - A functional clojure interface to the emulator supported by JNI
    1.12 +   bindings. 
    1.13 +
    1.14 + - The "Pokemon Yellow Total Control Hack" code
    1.15 +   (http://aurellem.org/vba-clojure/html/total-control.html), which
    1.16 +   uses the clojure bindings.
    1.17 +
    1.18 +
    1.19 +* License
    1.20 +
    1.21 +vba-rerecording is licensed under the GPL version 2, and I also
    1.22 +release all the code I have written relating to this project under the
    1.23 +GPL version 2.
    1.24 +
    1.25 +NOTE that the images under the /font directory and the mid files in
    1.26 +the /music directory were taken from http://www.zophar.net/ and
    1.27 +http://www.everyponysings.com/ respectively and are the only things in
    1.28 +this repository that are not under the GPL.
    1.29 +
    1.30 +
    1.31 +* How to Compile
    1.32 +
    1.33 +** Long version
    1.34 +
    1.35 +Compilation follows 5 steps:
    1.36 +
    1.37 +  1. Get java libraries
    1.38 +  2. Generate java JNI header and bindings
    1.39 +  3. generate autotools scripts
    1.40 +  4. configure
    1.41 +  5. make
    1.42 +
    1.43 +First, run the dl-libs.sh script to download the tritonus jars (or
    1.44 +otherwise obtain them), which are used in processing sound from the
    1.45 +gameboy. You must have wget installed for the dl-libs.sh to work.
    1.46 +
    1.47 +Second, you must generate the java JNI header and bindigs. cd to the
    1.48 +"java" directory and run `ant` to do this.
    1.49 +
    1.50 +Third, generate the autotools scripts which the project requires by
    1.51 +running `autoreconf -i`. I use autoreconf version 2.69.
    1.52 +
    1.53 +Fourth, run the "configure" script that was just produced to check for
    1.54 +dependencies and proper environment variables. Be sure to have the
    1.55 +environment variables JAVA_INCLUDE_PATH and JAVA_INCLUDE_PATH2
    1.56 +properly defined. "jni.h" should be in the directory referenced by
    1.57 +JAVA_INCLUDE_PATH, and "jni_md.h" should be in the directory
    1.58 +referenced by JAVA_INCLUDE_PATH2. On my system,
    1.59 +JAVA_INCLUDE_PATH=/usr/include and
    1.60 +JAVA_INCLUDE_PATH2=/usr/include/linux.
    1.61 +
    1.62 +finally, run `make` to build the library. You may optionally install
    1.63 +the library using `make install`.
    1.64 +
    1.65 +** Short Version
    1.66 +
    1.67 +./dl-libs.sh
    1.68 +cd java
    1.69 +ant
    1.70 +cd ..
    1.71 +autoreconf -i
    1.72 +./configure
    1.73 +make 
    1.74 +make install
    1.75 +
    1.76 +
    1.77 +
    1.78 +