README

                               VuFind
              Open Source Library Resource Discovery System
===============================================================================
I. Introduction

    VuFind is an electronic resource portal designed and developed for
    libraries by libraries. The goal of VuFind is to enable your users to
    search and browse through all of your library's electronic resources.

II. Requirements

    VuFind uses common open source web application components, including the
    Apache web server, PHP scripting language and MySQL database.

    The latest requirement list, including download links for various software
    packages, can be found here:

        http://vufind.org/wiki/requirements

III. Bundled Components

    VuFind is bundled with (and relies upon) several ready-built programs.  If you
    wish to rebuild or upgrade any of these components, you should visit their own
    project pages.

    Apache Solr (solr/jetty/webapps/solr.war)
        http://lucene.apache.org/solr/
    NLA Browse Handler (import/browse-indexing.jar; solr/lib/browse-handler.jar)
        https://github.com/marktriggs/nla-browse-handler
    Jetty (solr/jetty/*)
        http://jetty.codehaus.org/jetty/
    SolrMarc (import/SolrMarc.jar; import/VuFindIndexer.jar)
        http://code.google.com/p/solrmarc/

IV. Installation Procedure

    Installation details vary depending on your platform.  VuFind can run on
    Windows or various flavors of Linux.  For detailed instructions, please
    visit this link:

        http://vufind.org/wiki/installation

V. Security

    The latest notes on ensuring that your VuFind installation is secure can
    be found here:

        http://vufind.org/wiki/security

    Please review carefully!

VI. Copyright and Licensing

    Copyright (C) Villanova University 2007-2011.

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License version 2,
    as published by the Free Software Foundation.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

VII. Additional Credits

    The themes provided with VuFind make use of the free Fugue, Silk and Tango icon
    sets.  For more information on these icons, see:
        Fugue (copyright (c) Yusuke Kamiyamane): http://p.yusukekamiyamane.com/
        Silk: http://www.famfamfam.com/lab/icons/silk/
        Silk Companion: http://damieng.com/creative/icons/silk-companion-1-icons
        Tango: http://tango.freedesktop.org/