opengrok/doc/build.xhtml

	build.xhtml revision e7b21c8124ec55ffacc49c1e28a8685834715484
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
    <head>
        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
        <title>How to build {OpenGrok</title>
    </head>
    <body>
        <h1>How to build {OpenGrok</h1>
        <p>The easiest way to build (or modify) {OpenGrok is by using
            <a href="http://www.netbeans.org">NetBeans</a>, but you can also build
            {OpenGrok from the command line.
        </p>
        <h2>Requirements</h2>
        <p>You need the following:</p>
        <ul>
            <li><a href="http://java.sun.com/javase/downloads/index.jsp">JDK</a>
            1.6 or higher</li>
            <li><a href="http://ant.apache.org/">Apache Ant</a> 1.8 or later
            if you don't intend to build using NetBeans</li>
            <li>The source code is located in a
                <a href="http://www.selenic.com/mercurial/wiki/">Mercurial</a>
            repository</li>
            <li>The analyzers are generated from lex by using
            <a href="http://jflex.de/">JFlex</a></li>
        </ul>

        <h2>Check out the source</h2>
        <p>The first thing you need to do is to check out the source code. You
            might do this from within NetBeans if you have the Mercurial plugin
            installed, or you can check out the source with the following
            command:
        </p>

        <pre>git clone https://github.com/OpenGrok/OpenGrok</pre>

        <h2>Prepare the source for compilation</h2>
        <p>Copy <code>JFlex.jar</code> into the <code>lib</code> directory in
        the OpenGrok source. (If you are using NetBeans, you could
        alternatively add JFlex.jar to Ant's classpath at
        Tools-&gt;Options-&gt;Miscellaneous-&gt;Ant. If you are
        running Ant from the command line, it should also work if you put
        JFlex.jar into your <code>~/.ant/lib</code> directory.)
        </p>

        <h2>Compile the source</h2>
        <p>If you use NetBeans you should be able to open OpenGrok as a project
            and build it from there. If you want to build from the command line,
        execute the following command:</p>

        <pre>ant</pre>

        <p>If the build is successful, you should now find the
        binaries under the <code>dist</code> directory.</p>

    </body>
</html>