README

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