Changeset 18013

Show
Ignore:
Timestamp:
02.12.2008 18:09:13 (11 years ago)
Author:
max
Message:

Update the readme file to V2.81rc

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • release-kits/shared/greenstone2/docs/READMEen.txt

    r16227 r18013  
    77 
    88License GNU General Public Licence (Version 2) 
    9         Full terms and conditions are in the file "COPYING" on this CD-ROM 
     9        Full terms and conditions are in the file "LICENSE.txt" 
    1010 
    11 Date    November 2007 
     11Date    December 2008 
    1212 
    13 Version 2.75 
     13Version 2s2008.12.01 
    1414 
    15 Documentation 
    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 
     15Contents: Programs 
     16        Greenstone library server  A cgi program to serve digital library collections 
     17        Greenstone oaiserver           A cgi program to serve collections using the OAI-PMH protocol. 
     18        Greenstone Librarian Interface (GLI) 
     19                                   A graphical tool for collection building 
     20        Greenstone Editor for Metadata Sets (GEMS) 
     21                                   A graphical tool for creating and editing metadata sets used by GLI 
     22                 
     23Contents: Directory Structure 
     24        bin                 Executable code 
     25        cgi-bin             CGI scripts 
     26        collect             Collections 
     27        etc                 Configuration files, log files, user databases etc 
     28        gli                 Librarian Interface 
     29        images              Images and CSS files used by the interface 
     30        macros              Display macros 
     31        mappings            Unicode translation tables 
     32        perllib             Perl modules used for collection building 
     33         
     34        If source code is present (from a source release or by adding the source component): 
     35        common-src   Source code and packages used when building collections and at runtime 
     36        build-src    Source code and packages only used when building collections 
     37        runtime-src  Source code and packages only used at runtime 
    2038 
    21 Additional 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) 
     39Additional Packages 
     40           TODO java, image magick, perl, ... 
     41 
     42           Documentation and Support 
     43        Greenstone Website: 
     44                   http://www.greenstone.org 
     45                   Greenstone's main website. 
     46        Greenstone Wiki:  
     47                   http://wiki.greenstone.org 
     48                   Contains documentation, and links to manuals, tutorials etc... 
     49        Greenstone Mailing List: 
     50                   https://list.scms.waikato.ac.nz/mailman/listinfo/greenstone-users (to subscribe) 
     51                   greenstone-users@list.scms.waikato.ac.nz (to post) 
     52        New Zealand Digital Library:  
     53                   http://www.nzdl.org 
     54                   A demonstration site containing lots of collections 
     55 
    2556 
    2657Platform 
    27         Unix and Windows.  Binaries and source code are included. 
     58        Greenstone runs on Unix, Windows 2000/XP/2003/Vista/2008 and Mac OS 10.5.2 (Leopard). 
     59         
     60         
     61        The Greenstone Librarian Interface requires version 1.4 or later  
     62        of the Java Runtime Environment. Java 1.6 is included in the binary  
     63        release of Greenstone. 
    2864 
    2965        The Greenstone user interface uses a Web browser capable of Javascript, 
     
    3268                Netscape Navigator 4.0 
    3369                Internet Explorer 4.0 
    34                 Mozilla, Safari 
     70                Mozilla 
     71                Safari 
    3572 
    36         More recent versions of these browsers should also work. 
     73        More recent versions of these browsers should also work (recommended). 
    3774 
    3875 
    39 Unix    Source code has been compiled and tested on Linux and Solaris. 
     76         
     77Unix     
     78Source code has been compiled and tested on Linux and Solaris. 
    4079        Binary code requires an Intel x86-based Linux distribution which 
    4180        includes ELF binary support and supports the GNU C library (glibc 2.0 
     
    4887 
    4988        More recent versions of these distributions should also work.  
     89         
     90        We have tested Greenstone 2 on the following distributions: 
     91                Ubuntu 8.04 & 8.10 
     92                Mandriva 2008 Spring 
     93                OpenSUSE 11 
     94                Fedora 6 & 9 
     95                CentOS 5.2 
    5096 
    51 Windows 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 
     97Windows  
     98Source code can be compiled with Microsoft Visual C++ 6.0, 7 (VS 2003.Net),  
     998 (VS 2005 Pro or VC++ Express 2005 with Microsoft Platform SDK 2003 R2). 
    56100 
    57 Install 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. 
     101        Binary code has been tested on 32 bits version of: 
     102                Windows 2000 
     103                Windows XP 
     104                Windows Server 2003 
     105                Windows Vista 
     106                Windows Server 2008 
    61107 
    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. 
     108        Greenstone software (version 2.81 and later) no longer runs on  
     109                Windows 3.1 
     110                Windows 95 
     111                Windows 98 
     112                Windows Me 
     113                Windows NT 
    65114 
    66                 Windows 9x/NT/2000/XP installation:   execute setup.exe 
    67                 Unix installation:                    execute setupLinux.bin 
     115Mac 
     116Source code has been compiled with Xcode 3.1 on Intel Mac OS 10.5.2. 
     117Binary has been tested on Intel Mac OS 10.5.2 (Leopard). 
    68118 
    69         Uninstall scripts are provided which clean up should installation fail. 
    70  
    71 Support 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  
    79 Contents 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 
     119However the source code can be compiled with other versions of Mac OS and Xcode, 
     120in that case please download Imagemagick and Ghostscript to recompile them from source.