README

   1 bnac is a program for creating virtual museum environments.
   2
   3 bnac is Free Software. See COPYING file for license.
   4
   5 Documentation is a bit lacking right now, and so is the code ;-)
   6
   7 Software requirements
   8 =====================
   9
  10 Library dependencies:
  11 - slf4j >= 1.6
  12 - libvecmath >= 1.5.2
  13
  14 The corresponding JAR files must be either put or symlinked from the directory
  15 `lib'. That is to say, for example,
  16     $ cd path/to/bnac-common
  17     $ mkdir lib && cd lib
  18     $ ln -s /usr/share/java/vecmath.jar
  19
  20 For building:
  21 - ant >= 1.8
  22
  23 (The version constraints are just the ones that the project was built with,
  24 maybe it works with previous versions, maybe not.)
  25
  26 Building instructions
  27 =====================
  28
  29 $ cd path/to/bnac-common
  30 $ ant
  31
  32 That's it ;-)
  33
  34 As this is just a library, the generated JAR is in the `dist' directory.
  35
  36 Testing
  37 =======
  38
  39 There is a test class which right now which tests parsing Meml and Info files.
  40
  41 There is a testing directory called (suitably) `test'. To build, simply call,
  42     $ ant test
  43
  44 Then call,
  45     $ java -cp lib/*:build:test/build:test Test ( meml | info ) file.xml
  46
  47 To view logs, JARs for both log4j and the slf4j adapter must be put in the `lib'
  48 directory, the same way as other required JARs. To change logging rules, alter
  49 the file `test/log4j.properties'.
  50