The recommended branch to use. Easier to build and maintain.
Use a git client to keep in sync with our working copy:
git clone git://clucene.git.sourceforge.net/gitroot/clucene/clucene
Alternatively, you can download a tarball through our WebGUI (click "snapshot").
Build instructions (more info in the INSTALLATION and README files):
Building from source:
--------------------
Dependencies:
* CMake version 2.4.2 or later (2.6 or later recommended due to an improved FindBoost module).
* Boost libs (http://www.boost.org/), latest version recommended.
* A functioning and fairly new C++ compiler. We test mostly on GCC and Visual Studio 6+.
Anything other than that may not work.
* Something to unzip/untar the source code.
Build instructions:
1.) Download the latest source code of the HEAD of the master branch in our git repository.
2.) Unpack the tarball/zip/bzip/whatever if downloaded as such.
3.) Open a command prompt, terminal window, or Cygwin session.
4.) Change directory into the root of the source code (from now on referred as ).
# cd
5.) Create and change directory into an 'out-of-source' directory for your build.
[This is by far the easiest way to build. It has the benefit of being able to
create different types of builds in the same source-tree.]
# mkdir /build-name
# cd /build-name
5*.) Windows users: make sure Boost environment variables are defined at least for the current
command prompt session. You can check this by typing "set" (no quotes). If you have any doubts,
just type the following 3 commands to set those variables, as follows (boost_1_40_0 being the
current Boost version):
set BOOST_BUILD_PATH=C:\{parent directory for boost}\boost_1_40_0\tools\build\v2
set BOOST_PATH=C:\{parent directory for boost}
set BOOST_ROOT=C:\{parent directory for boost}\boost_1_40_0
6.) Configure using CMake. This can be done many different ways, but the basic syntax is
# cmake [-G "Script name"] ..
[Where "Script name" is the name of the scripts to build (e.g. Visual Studio 8 2005).
A list of supported build scripts can be found by]
# cmake --help
7.) You can configure several options such as the build type, debugging information,
mmap support, etc., by using the CMake GUI or by calling
# ccmake ..
Make sure you call configure again if you make any changes.
8.) Start the build. This depends on which build script you specified, but it would be something like
# make
or
# nmake
Or open the solution files with your IDE.
[You can also specify to just build a certain target (such as cl_test, cl_demo,
clucene-core (shared library), clucene-core-static (static library).]
9.) The binary files will be available in build-name/bin.
10.)Test the code. (After building the tests - this is done by default, or by calling make cl_test)
# ctest -V
11.)At this point you can install the library:
# make install
[There are options to do this from the IDE, but I find it easier to create a
distribution (see instructions below) and install that instead.]
or
# make cl_demo
[This creates the demo application, which demonstrates a simple text indexing and searching].
or
Adjust build values using ccmake or the CMake GUI and rebuild.
12.)Now you can develop your own code. This is beyond the scope of this document.
Read the README for information about documentation or to get help on the mailing list.
