* Initial import, stable version.
[bnac-visitor.git] / README
blobceb8362f7f33d9aabc75bf1abe6de1f8455a144d
1 bnac is a program for creating virtual museum environments.
3 bnac is Free Software. See COPYING file for license.
5 Documentation is a bit lacking right now, and so is the code ;-)
7 Software requirements
8 =====================
10 Library dependencies:
11 - bnac-common ( http://repo.or.cz/w/bnac-common.git )
12 - libvecmath >= 1.5.2
13 - libslf4j-android >= 1.5.8
15 The corresponding JAR files must be either put or symlinked from the directory
16 `lib'. That is to say, for example,
17     $ cd path/to/bnac-common
18     $ mkdir lib && cd lib
19     $ ln -s /usr/share/java/vecmath.jar
21 For building:
22 - ant >= 1.8
24 (The version constraints are just the ones that the project was built with,
25 maybe it works with previous versions, maybe not.)
27 Building instructions
28 =====================
30 $ cd path/to/bnac-visitor
31 $ ant compile
33 That's it ;-)
35 Testing
36 =======
38 If there is an Android emulator or debuggable device attached, the command,
39     $ ant install
40 will install the package on it for testing purposes.
42 To view logs, the android debugging bridge can be used,
43     $ adb logcat cl.uchile.dcc.bnac:*