Skip to content
Snippets Groups Projects
README.md 1.37 KiB
Newer Older
Demian Katz's avatar
Demian Katz committed
[![Build Status](https://travis-ci.org/vufind-org/vufind.svg?branch=master)](https://travis-ci.org/vufind-org/vufind)
VuFind
======

Introduction
------------
VuFind is an open source discovery environment for searching a collection of
Demian Katz's avatar
Demian Katz committed
records.  To learn more, visit https://vufind.org.
Demian Katz's avatar
Demian Katz committed
See our [online installation documentation](https://vufind.org/wiki/installation) for step-by-step instructions for installing from packaged releases to popular platforms.

VuFind's [packaged releases](http://vufind-org.github.io/vufind/downloads.html) have all dependencies included. If you are installing directly from a Git checkout, you will need to load these dependencies manually by following these steps from inside VuFind's home directory:

- Load PHP dependencies using the [Composer](https://getcomposer.org) tool by running `composer install`.
- Install Solr using the [Phing](https://www.phing.info/) tool by running `phing installsolr`.
Demian Katz's avatar
Demian Katz committed


Documentation and Support
-------------------------
The VuFind community maintains a detailed [wiki](http://vufind.org/wiki) containing information on using and customizing the software. The VuFind website also lists [sources of community and commercial support](http://vufind-org.github.io/vufind/support.html).

Chris Hallberg's avatar
Chris Hallberg committed
Contributing
------------
See our [developers handbook](https://vufind.org/wiki/development) for more information.