mcs/tools/monodoc/Lucene.Net/BUILD.txt

   1 Lucene Build Instructions\r
   2 \r
   3 $Id: BUILD.txt,v 1.8 2004/04/03 21:32:50 ehatcher Exp $\r
   4 \r
   5 Basic steps:\r
   6   0) Install JDK 1.2 (or greater), Ant 1.6 (or greater), and the Ant\r
   7      optional.jar\r
   8   1) Download Lucene from Apache and unpack it\r
   9   2) Connect to the top-level of your Lucene installation\r
  10   3) Install JavaCC (optional)\r
  11   4) Run ant\r
  12 \r
  13 Step 0) Set up your development environment (JDK 1.2 or greater,\r
  14 Ant 1.6 or greater)\r
  15 \r
  16 We'll assume that you know how to get and set up the JDK - if you\r
  17 don't, then we suggest starting at http://java.sun.com and learning\r
  18 more about Java, before returning to this README.\r
  19 \r
  20 Lucene runs with JDK 1.2 and later.  However, if you're going to work\r
  21 with the development version of Lucene, we recommend you stick with\r
  22 the most current version of Java (at the time of this writing, JDK\r
  23 1.4).  Also, note that if you're working with the Lucene source,\r
  24 you'll need to use Ant (see below) and Ant requires at least JDK 1.2.\r
  25 \r
  26 Like most of the Jakarta projects, Lucene uses Apache Ant for build\r
  27 control.  Specifically, you MUST use Ant version 1.6 or greater.\r
  28 \r
  29 Ant is "kind of like make without make's wrinkles".  Ant is\r
  30 implemented in java and uses XML-based configuration files.  You can\r
  31 get it at:\r
  32 \r
  33   http://ant.apache.org\r
  34 \r
  35 You'll need to download both the Ant binary distribution and the\r
  36 "optional" jar file.  Install these according to the instructions at:\r
  37 \r
  38   http://ant.apache.org/manual\r
  39 \r
  40 Step 1) Download Lucene from Apache\r
  41 \r
  42 We'll assume you already did this, or you wouldn't be reading this\r
  43 file.  However, you might have received this file by some alternate\r
  44 route, or you might have an incomplete copy of the Lucene, so: Lucene\r
  45 releases are available for download at:\r
  46 \r
  47   http://jakarta.apache.org/builds/jakarta-lucene/release/\r
  48 \r
  49 Download either a zip or a tarred/gzipped version of the archive, and\r
  50 uncompress it into a directory of your choice.\r
  51 \r
  52 Step 2) Connect to the top-level of your Lucene installation\r
  53 \r
  54 Lucene's top-level directory contains the default.properties and\r
  55 build.xml files. By default, you do not need to change any of the\r
  56 settings in these files, but you do need to run ant from this location\r
  57 so it knows where to find them.\r
  58 \r
  59 If you would like to change the settings in the default.properties there\r
  60 is no need to edit the default.properties file, you can override the\r
  61 property settings by creating one or more of the following files and\r
  62 placing your own property settings in there:\r
  63 \r
  64     ~/lucene.build.properties\r
  65     ~/build.properties\r
  66     jakarta-lucene/build.properties\r
  67 \r
  68 The first property which is found in the order with which the files are\r
  69 loaded becomes the property setting which is used by the Ant build\r
  70 system.\r
  71 \r
  72 NOTE: the ~ character represents your user account home directory.\r
  73 \r
  74 Step 3) Install JavaCC\r
  75 \r
  76 Building the Lucene distribution from the source does not require the JavaCC\r
  77 parser generator, but if you wish to regenerate any of the pre-generated\r
  78 parser pieces, you will need to install JavaCC.\r
  79 \r
  80   http://javacc.dev.java.net\r
  81 \r
  82 Follow the download links and download the zip file to a temporary\r
  83 location on your file system.\r
  84 \r
  85 After JavaCC is installed, edit your build.properties\r
  86 (as in step 2), and add the line\r
  87 \r
  88   javacc.home=/javacc/bin\r
  89 \r
  90 where this points to the bin directory of your javacc installation.\r
  91 \r
  92 Step 4) Run ant\r
  93 \r
  94 Assuming you have ant in your PATH and have set ANT_HOME to the\r
  95 location of your ant installation, typing "ant" at the shell prompt\r
  96 and command prompt should run ant.  Ant will by default look for the\r
  97 "build.xml" file in your current directory, and compile Lucene.\r
  98 \r
  99 To rebuild any of the JavaCC-based parsers, run "ant javacc".\r
 100 \r
 101 For further information on Lucene, go to:\r
 102   http://jakarta.apache.org/lucene/\r
 103 \r
 104 Please join the Lucene-User mailing list by visiting this site:\r
 105   http://jakarta.apache.org/site/mail.html\r
 106 \r
 107 Please post suggestions, questions, corrections or additions to this\r
 108 document to the lucene-user mailing list.\r
 109 \r
 110 This file was originally written by Steven J. Owens <puff@darksleep.com>.\r
 111 This file was modified by Jon S. Stevens <jon@latchkey.com>.\r
 112 \r
 113 Copyright (c) 2001-2004 The Apache Software Foundation.  All rights reserved.\r