1Welcome to the Xapian repository!
4Xapian is split into several modules, which are held in sub-directories of
5the directory containing this file. The core code and documentation is in
6the xapian-core module.
8If you're new to hacking on Xapian, you should probably start by reading the
9xapian-core/HACKING file. If you're new to Xapian entirely, you should
10probably read the xapian-core/README file, or you can find further information
11on our website at http://xapian.org/
13See the section "Building from git" in xapian-core/HACKING for details
14on getting started.
16Experimental: we have support for building an Ubuntu VM using Vagrant
17and VirtualBox. `vagrant up` will start the process, although it can
18currently take a long time to download and install all the relevant
19packages. See "Using a Vagrant-driven Ubuntu virtual machine" in
20xapian-core/HACKING for details.