diff options
Diffstat (limited to 'juniper/README')
-rw-r--r-- | juniper/README | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/juniper/README b/juniper/README new file mode 100644 index 00000000000..f044cad83e8 --- /dev/null +++ b/juniper/README @@ -0,0 +1,36 @@ + +This module implements a result processing solution to create +dynamic teasers and proximity boosting of documents based on the +input query. + +The module offers the following main interface: + +rpinterface.h + + This interface provides access for Juniper to full query structure information. + The query provider needs to implement the IQuery interface to allow Juniper + to traverse the query and possibly obtain additional information about each term. + (see query.h which is included by rpinterface.h) + + This is the preferred result processing interface to Juniper. + + src/rpclient/testclient.cpp + + is an example of use of this interface. + + +Directory structure: +------------------------- +build - contains the fbuild official build specification for Juniper +doc - contains manually written and generated (doxygen) documentation + for Juniper. +include - default public include file location +lib - default library location +src - the main source directory +src/rpclient - example and regression test client +src/test - unit and submodule tests using the Fastlib test framework +src/util - contains some debug utilities for debugging/converting between + unicode/iso character sets. + +See INSTALL.txt for build instructions. + |