root/release-kits/shared/greenstone2/docs/READMEen.txt @ 18053

Revision 18053, 3.9 KB (checked in by oranfry, 11 years ago)

updated english reademe file

Line 
1Title   Greenstone digital library software
2
3Purpose A suite of digital library software which includes the ability to
4        serve digital library collections and build new collections
5
6Author  New Zealand Digital Library Project
7
8License GNU General Public Licence (Version 2)
9        Full terms and conditions are in the file "LICENSE.txt"
10
11Date    December 2008
12
13Version svn-trunk
14
15Contents: Programs
16
17        Greenstone library server  A cgi program to serve digital library
18                   collections
19        Greenstone oaiserver       A cgi program to serve collections using
20                   the OAI-PMH protocol.
21        Greenstone Librarian Interface (GLI)
22                                   A graphical tool for collection building
23        Greenstone Editor for Metadata Sets (GEMS)
24                                   A graphical tool for creating and editing
25                   metadata sets used by GLI
26               
27Contents: Directory Structure
28
29        bin     Executable code
30        cgi-bin     CGI scripts
31        collect     Collections
32        etc     Configuration files, log files, user databases etc
33        gli     Librarian Interface
34        images      Images and CSS files used by the interface
35        macros      Display macros
36        mappings    Unicode translation tables
37        perllib     Perl modules used for collection building
38       
39    If source code is present (from a source release or by adding the
40    source component):
41        common-src  Source code and packages used when building collections
42             and at runtime
43        build-src   Source code and packages only used when building
44            collections
45        runtime-src Source code and packages only used at runtime
46
47Contents: Additional Packages (available only in full binary releases)
48
49    Java Runtime 1.6 (installer release only)
50    ImageMagick
51    Ghostscript (Windows, Mac only)
52    Perl (Windows only)
53
54Documentation and Support
55        Greenstone Website:
56            http://www.greenstone.org
57            Greenstone's main website.
58        Greenstone Wiki:
59            http://wiki.greenstone.org
60            Contains documentation, and links to manuals, tutorials
61             etc.
62        Greenstone Mailing List:
63            https://list.scms.waikato.ac.nz/mailman/listinfo/greenstone-users (to subscribe)
64            greenstone-users@list.scms.waikato.ac.nz (to post)
65        New Zealand Digital Library:
66            http://www.nzdl.org
67            A demonstration site containing lots of collections
68
69
70Platform
71       
72    Greenstone runs on Unix, Windows 2000/XP/2003/Vista/2008 and
73    Mac OS 10.5.2 (Leopard).
74       
75        The Greenstone Librarian Interface requires version 1.4 or later
76        of the Java Runtime Environment. Java 1.6 is included in binary
77        releases of Greenstone.
78
79        The Greenstone user interface uses a Web browser capable of Javascript,
80        Tables, and Frames.  Browsers that meet these requirements include:
81
82                Netscape Navigator 4.0
83                Internet Explorer 4.0
84                Mozilla
85        Safari
86
87        More recent versions of these browsers should also work (recommended).
88       
89Unix   
90    Source code has been compiled and tested on the following
91    distributions:
92
93        Ubuntu 8.04 & 8.10
94        Mandriva 2008 Spring
95        OpenSUSE 11
96        Fedora 6 & 9
97        CentOS 5.2
98
99
100Windows
101    Source code can be compiled with Microsoft Visual C++ 6.0, 7
102    (VS 2003.Net), 8 (VS 2005 Pro or VC++ Express 2005 with Microsoft
103    Platform SDK 2003 R2).
104
105        Binary code has been tested on 32 bit versions of:
106        Windows 2000
107        Windows XP
108        Windows Server 2003
109        Windows Vista
110        Windows Server 2008
111
112        Greenstone software (version 2.81 and later) no longer runs on
113        Windows 3.1
114        Windows 95
115        Windows 98
116        Windows Me
117        Windows NT
118
119Mac
120    Source code has been compiled with Xcode 3.1 on Intel Mac OS 10.5.2.
121    Binary has been tested on Intel Mac OS 10.5.2 (Leopard).
122
123    However the source code can be compiled with other versions of Mac OS
124    and Xcode, in that case please download Imagemagick and Ghostscript to
125    recompile them from source.
Note: See TracBrowser for help on using the browser.