Context Navigation

README

Revision 3625, 3.6 kB (checked in by jburel, 2 years ago)
updated
Property svn:mime-type set to `application/octet-stream`

Line
1
2
3
4	README
5
6	OPEN MICROSCOPY ENVIRONMENT (OME)
7
8	S H O O L A
9
10
11
12
13
14
15
16	OME-Shoola Project
17	------------------
18
19	The OME-Shoola Project is a sub-project of the Open Microscopy Environment
20	Project (OME, http://www.openmicroscopy.org/) that focuses on delivering a
21	client for the visualization and manipulation of both image data and metadata
22	maintained at an OME server site. Shoola is completely written in Java.
23
24
25
26	Directory Contents
27	------------------
28
29	This directory is the repository of the software artifacts of the OME-Shoola
30	Project. Its contents are as follows:
31
32	+ build: This directory contains the tools to compile, run, test, and
33	deliver the application.
34	+ config: Various configuration files required by the application to run.
35	+ docgen: Documentation artifacts that are used to build actual documents.
36	These are organized in two sub-directories: javadoc and xdocs. The
37	former only contains resources (like CSS files)to generate
38	programmer's documentation (JavaDoc) -- the actual documentation
39	contents are obtained from the source code. The latter contains both
40	resources (like stylesheets and DHTML code) to generate all other
41	kinds of documentation (like design and users documents) and the
42	actual documentation contents in the form of XML/HTML files.
43	+ launch: Launcher scripts and installation instructions bundled with the
44	default application distribution file. Its sub-dirs contain further
45	resources to build platform-specific distributions.
46	+ legal: Terms and conditions under which the various artifacts in this
47	repository are released. A README file specifies which license
48	applies to which artifact.
49	+ LIB: All library files required by the application. Its test sub-dir
50	contains additional libraries required by the test code.
51	+ SRC: Contains the application source files.
52	+ TEST: The test code.
53	+ CodeTemplate: This file describes the coding style that all source files
54	must conform to.
55	+ README: This file.
56
57
58
59	Building Shoola
60	---------------
61
62	The compilation, testing, launch, and delivery of the application are
63	automated by means of an Ant (http://ant.apache.org/) build file, located
64	under the build directory. In order to perform a build, all you need is
65	a JDK -- version 1.4 or later. Move to the build directory and, from the
66	command line, enter:
67
68	java build
69
70	This will display the available targets to compile, run, test, and create a
71	distribution bundle. Use the target you wish, for example:
72
73	java build all
74
75	Because all the tools needed to build the software are already included in
76	the build directory, you don't need to have Ant on your machine.
77	If you wish to use Ant instead, you can still do it by using the build.xml
78	file under the build directory. However, there are some dependencies to
79	satisfy before; these are clearly documented in the build.xml file itself.
80
81	Licensing
82	---------
83
84	This software is licensed under the terms of the GNU Lesser General Public
85	License (LGPL), a copy of which may be found in the lgpl.txt file under the
86	'legal' directory. The README file in that directory states which other
87	licenses apply to third-party artifacts used by our software.
88
89
90
91	Copyright
92	---------
93
94	Copyright (C) 2003-2005 Open Microscopy Environment
95	Massachusetts Institute of Technology,
96	National Institutes of Health,
97	University of Dundee
98

Note: See TracBrowser for help on using the browser.

Context Navigation

root/tags/Shoola_3.0_M3/README

Download in other formats: