Context Navigation

README

Revision 5390, 3.6 kB (checked in by jburel, 7 months ago)
update copyright
Property svn:mime-type set to `application/octet-stream`

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

Note: See TracBrowser for help on using the browser.

Context Navigation

root/trunk/README

Download in other formats: