Correct typo: .clangformat -> .clang-format
[xapian.git] / xapian-letor / INSTALL
blob701841876d44bab66f7b3cde4371b7dc7e58afb9
1 Welcome to Xapian's Learning to Rank Framework
2 ==============================================
4 Xapian's build system is built using GNU autoconf, automake, and libtool.
5 If you've installed other Open Source projects from source, you should
6 find yourself in familiar territory.  Building and installing involves
7 the following 3 simple steps:
9  1) Run "./bootstrap xapian-core xapian-letor" in the top level directory.
10     Note: It is preferred that you bootstrap all of the xapian project together.
11     To do that, run:
12     "./bootstrap xapian-core xapian-applications/omega swig xapian-bindings xapian-letor"
13  2) Run "./configure", possibly with some extra arguments
14  3) Run "make" to build
15  4) Run "make install" to install
17 Prerequisites
18 =============
20 You'll need to install the following prerequisites before you can
21 build xapian-letor:
23  * xapian-core: We recommend using matching versions of xapian-core and
24    xapian-letor.  If you install xapian-core from a package, make sure you
25    also install the development files which are often packaged separately
26    (e.g. in libxapian-dev or xapian-core-devel).
28  * libsvm (http://www.csie.ntu.edu.tw/~cjlin/libsvm/): We developed
29    xapian-letor using libsvm version 3.1, but we've also tested with 3.0
30    and that seems to work fine too.
32    If you install libsvm from a package system, make sure you have the
33    headers and other files needed to actually build code that uses libsvm
34    (not just the runtime libraries) - if you have /usr/include/libsvm/svm.h
35    then you are probably good.  Often these files are in a separate
36    package, which is probably named something like libsvm-dev or
37    libsvm-devel.
39    On Mac OS X, if you installed libsvm using homebrew but got the following
40    error when running the configure script:
42       configure: error: libsvm required but libsvm/svm.h not found
44    Suppose you are using libsvm 3.21, you can type the following into terminal
45    and rerun the configure script:
47       ln -s /usr/local/Cellar/libsvm/3.21/include/ /usr/local/include/libsvm