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 developer guide:
  10
  11 * Online: https://xapian-developer-guide.readthedocs.io/
  12 * Source on github: https://github.com/xapian/xapian-developer-guide
  13
  14 If you're new to Xapian entirely, you should probably read our user
  15 guide, and then look for further information on our website at
  16 https://xapian.org/
  17
  18 * User guide online: https://getting-started-with-xapian.readthedocs.io/
  19 * Source on github: https://github.com/xapian/xapian-docsprint
  20
  21 Experimental: we have support for building an Ubuntu VM using Vagrant
  22 and VirtualBox.  The command ``vagrant up`` will start the process, although
  23 it can currently take a long time to download and install all the relevant
  24 packages. See "Using a Vagrant-driven Ubuntu virtual machine" in
  25 xapian-core/HACKING for details.