Merge branch 'ict' of git+ssh://leafwd@repo.or.cz/srv/git/trakem2 into ict
[trakem2.git] / README
blob59609eb9c6368a6cd078eb02095591a842e073cf
1 TrakEM2
2 -------
4 Copyright 2005, 2006, 2007 Albert Cardona and Rodney Douglas.
6 Contact: acardona at ini phys ethz ch
8 To compile the source you need:
9 - A java system compliant with Java 1.5.0 (Sun Microsystems), but 1.6.0 is STRONGLY recommended.
10 - ImageJ 1.37g or higher from http://rsb.info.nih.gov/ij/upgrade/
11 - The PostgreSQL JDBC driver, from http://jdbc.postgresql.org/download/postgresql-8.1-405.jdbc3.jar
12 - A number of jars (precompiled for java 1.6.0):
13         http://www.ini.uzh.ch/~acardona/jars/edu_mines_jtk.jar
14         http://www.ini.uzh.ch/~acardona/jars/ImageJ_3D_Viewer.jar
15         http://www.ini.uzh.ch/~acardona/jars/AmiraMesh_.jar
16         http://www.ini.uzh.ch/~acardona/jars/jzlib-1.0.7.jar
17         http://www.ini.uzh.ch/~acardona/jars/Jama-1.0.2.jar
19 You can get the latest source code from the git repository at:
20         http://repo.or.cz/w/trakem2.git
22 It is strongly recommended to use Java 1.6.0 whenever possible, since repainting speed is much higher.
24 To compile, use a script similar to:
26         $ javac -classpath ij.jar:$(find . -name "*.jar" -printf "%h/%f:"):. $(find . -name "*.java" -printf "%h/%f ")
28 You can then create a jar file using:
30         $ jar cf TrakEM2_.jar plugins.config $(find . -name "*.class" -printf "%h/%f ")
34 which can be placed in the ImageJ plugins folder and will appear as a menu:
35 Plugins
36    |
37    --- TrakEM2
38           |
39           --- New Project (from template)
40           --- New Project (blank)
41           --- Open Project
44 A postgresql database is OPTIONAL: as of version 0.3g, XML / file system -based projects are also available.
46 In an XML project, images exist in your folders wherever you choose, and then the entire project details (segmentations, labels, transformations of the images, etc) live in a single .xml file.
48 For database projects, a PostgreSQL database (7.4.* or 8.1.3 or above) is required. 
49 Get PostgreSQL from http://www.postgresql.org
52 Have fun! Beer and comments to acardona at ini phys ethz ch