source: release-kits/shared/greenstone2/docs/READMEen.txt@ 17272

Last change on this file since 17272 was 16227, checked in by oranfry, 16 years ago

keeping the README files in the release kit rather than in /home/nzdl/gsdl-docs, so you don't have to be in the department to create a release

File size: 8.9 KB
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 "COPYING" on this CD-ROM
10
11Date November 2007
12
13Version 2.75
14
15Documentation
16 Install.pdf Greenstone Digital Library Installer's Guide
17 User.pdf Greenstone Digital Library User's Guide
18 Develop.pdf Greenstone Digital Library Developer's Guide
19 Paper.pdf From paper to collection
20
21Additional Utilities
22 Librarian Interface A graphical tool for collection building using
23 Greenstone (requires version 1.4 of the Java
24 Runtime Environment, included on this CD-ROM)
25
26Platform
27 Unix and Windows. Binaries and source code are included.
28
29 The Greenstone user interface uses a Web browser capable of Javascript,
30 Tables, and Frames. Browsers that meet these requirements include:
31
32 Netscape Navigator 4.0
33 Internet Explorer 4.0
34 Mozilla, Safari
35
36 More recent versions of these browsers should also work.
37
38
39Unix Source code has been compiled and tested on Linux and Solaris.
40 Binary code requires an Intel x86-based Linux distribution which
41 includes ELF binary support and supports the GNU C library (glibc 2.0
42 or greater). Distributions that meet these requirements include:
43
44 RedHat 5.1
45 SuSE Linux 6.1
46 Debian 2.1
47 Slackware 4.0
48
49 More recent versions of these distributions should also work.
50
51Windows Source code has been compiled with Microsoft Visual C++ 4.2 and 6.0
52 Binary code has been tested on Windows 3.1, 95/98, NT, 2000, XP
53 Restriction:
54 The building process requires PERL, and so collections cannot
55 be built under Windows 3.1
56
57Install Install.pdf describes the complete installation procedure for both Unix
58 and Windows, and includes tutorial information about configuring
59 Greenstone and configuring the Apache, PWS and IIS Web Servers
60 appropriately.
61
62 Self-explanatory install scripts are provided for both Unix and
63 Windows, which take you step by step through the installation procedure
64 and provide appropriate options at each stage.
65
66 Windows 9x/NT/2000/XP installation: execute setup.exe
67 Unix installation: execute setupLinux.bin
68
69 Uninstall scripts are provided which clean up should installation fail.
70
71Support Please report any problems installing or running the Greenstone Digital
72 Library Software using the bug report form provided as Support.htm in
73 the top level directory of this CD-ROM.
74
75 There is a Greenstone mailing list that you can join at
76 http://greenstone.org/english/docs.html. Both this page and the faq list
77 at this site point to a lot of helpful information.
78
79Contents of this CD-ROM
80
81 README.TXT This document
82
83 COPYING Gives the conditions under which this software can be
84 copied
85
86 Support.htm Form for reporting problems installing or running
87 Greenstone
88
89 setup.exe Windows self-install program (includes
90 option to install binaries or source)
91
92 setupLinux.bin Linux self-install program (includes
93 option to install binaries or source)
94
95
96 docs Documentation, including the following:
97
98 Install.pdf Installer's Guide
99 Describes the installation procedure
100 for both Unix and Windows, and includes
101 tutorial information about configuring
102 Greenstone and the Apache Web Server.
103
104 User.pdf User's Guide
105 Provides a comprehensive description of
106 how to use the Greenstone software for
107 accessing and building collections.
108
109 Develop.pdf Developer's Guide
110 This manual describes how Greenstone
111 works. It is aimed at those who wish
112 to customize collections and to develop
113 and maintain the software.
114
115 Paper.pdf From Paper to Collection
116 This manual gives practical information
117 on creating digitized collections from
118 full text documents.
119
120 Unix Unix version, including Linux binaries
121
122 The top-level files and directories are:
123
124 Install.sh Unix installation shell script (if run
125 on Linux, includes option to install
126 binaries; otherwise installs source)
127 bin Linux binaries
128
129 Windows Windows binaries
130
131 The top-level files and directories are:
132
133 bin Windows binaries
134
135 gsdl Greenstone digital library software directory structure.
136 This mirrors the Greenstone digital library directory
137 structure that will be installed.
138
139 bin Executable code
140 cgi-bin CGI scripts
141 collect Greenstone collections
142 (includes Demo collection, pre-built
143 indexes and source documents)
144 etc Configuration files, logs, etc
145 gli Greenstone Librarian Interface tool
146 images Images used by interface
147 macros Display macros
148 perllib Perl modules used when building
149 mappings Unicode translation tables
150
151 The installation procedure installs files into some of
152 these directories as follows:
153
154 top level Batch file or shell script
155 bin Executable code
156 cgi-bin CGI scripts
157 collect The Greenstone Demo collection
158 Additional collections as specified at
159 install time
160 src, lib, packages
161 Source code if specified at install
162 time
163
164 collect Greenstone collections (prebuilt) - note that although
165 the install procedure only installs the prebuilt indexes,
166 the original source documents for each collection are
167 available on the CD-ROM. The source documents may be
168 useful for those attempting to create new collections
169 which copy the format of these collections.
170
171 demo Greenstone demo
172 dls-e Development Library Subset collection
173 wrdpdf-e MSWord and PDF demonstration
174 gsarch-e Greenstone Archives collection
175 cltbib-e Bibliography collection
176 cltext-e Bibliography supplement
177 MARC-e MARC example
178 oai-e OAI demo
179 image-e Simple image collection
180 pagedimg-e Paged image collection
181 authen-e Formatting and authentication demo
182 garish Garish version of demo collection
183 style-e CSS demo collection
184 isis-e CDS/ISIS example
185
186 src Program source files
187
188 Windows Configuration information for Windows
189 Unix Configuration information for Unix
190 lib C++ library code
191 packages C++ source code for packages used by
192 Greenstone
193 src C++ source code
Note: See TracBrowser for help on using the repository browser.