Copyright © 2002
The Feynman Project
This distribution includes the source Java files that can be compiled to produce the feynman.jar file that is included in the Binary distribution. To compile the source code you must have Ant installed on your machine. The following steps show how to physically compile the source code:
wbailey:/tmp/feynman-0.9-src> ant package Buildfile: build.xml prepare: [mkdir] Created dir: /tmp/feynman-0.9-src/build [mkdir] Created dir: /tmp/feynman-0.9-src/build/lib [mkdir] Created dir: /tmp/feynman-0.9-src/build/classes [mkdir] Created dir: /tmp/feynman-0.9-src/build/doc [mkdir] Created dir: /tmp/feynman-0.9-src/build/doc/api build: [javac] Compiling 24 source files to /tmp/feynman-0.9-src/build/classes package: [jar] Building jar: /tmp/feynman-0.9-src/build/lib/feynman.jar BUILD SUCCESSFUL Total time: 6 secondsThe directions assume that you put the tarball in the /tmp directory. For more on how to unpack the tarball then see the Installation section of the Documentation for help on each type of operating system.
Notice the location of the feynman.jar package file. If you want to use the Framework, then make sure you copy this file to application top level directory along with the contents of the lib directory. For more on the directory structure needed to use the Framework then see the Sample Application documentation.
To view the JavaDoc for the Framework then just invoke the javadoc argument to ant and it will build the class library documentation in the build/doc/api directory.
wbailey:/tmp/feynman-0.9-src> ant javadoc Buildfile: build.xml prepare: build: package: javadoc: [javadoc] Generating Javadoc [javadoc] Javadoc execution [javadoc] Loading source files for package feynman.framework.controller... [javadoc] Loading source files for package feynman.framework.datastore... [javadoc] Loading source files for package feynman.framework.simulation... [javadoc] Loading source files for package feynman.framework.system... [javadoc] Constructing Javadoc information... [javadoc] Building tree for all the packages and classes... [javadoc] Building index for all the packages and classes... [javadoc] Building index for all classes... BUILD SUCCESSFUL Total time: 9 seconds