Changeset 389 for trunk/se


Ignore:
Timestamp:
Aug 14, 2007, 3:02:23 PM (16 years ago)
Author:
Peter Johansson
Message:

refs #53 working on new INSTALL instructions for WeNNI plugin

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/se/lu/thep/wenni/INSTALL

    r317 r389  
    3131to improve them. My email address is jari@thep.lu.se
    3232
     33This package can be built in three different modes: base2, base1, and
     34stand-alone. The base2 mode is default and the mode you should use if
     35you plan on running WeNNI as plugin to BASE2. The base1 mode is the
     36old (classic) mode similar WeNNI 0.6 (or earlier). This is the mode
     37you should use if you plan on using WeNNI as a plugin to BASE1. The
     38stand-alone mode is intended for you who want to use the WeNNI
     39algorithm independently of BASE. The different modes build and require
     40different things. You choose the mode by giving the `configure` script
     41the appropriate option. See below for more details on the different modes
    3342
    34 Pre-requisite:
     43= BASE 2 =
     44
     45== Pre-requisite ==
     46
     47 1. Download and install GSL, http://www.gnu.org/software/gsl/.
     48 2. A working a Base2 installation.
     49
     50== WeNNI install ==
     51
     52 1. Download and unpack WeNNI. `cd` to the root directory of the distribution.
     53
     54 2. Run configure script with
     55    $ `./configure`
     56
     57 The configure script accepts a few options that may be of
     58interest. You can provide `./configure` with BASE location information
     59with `--with-basedir=DIR`. This information is used to find jar files
     60such as `BASE2Core.jar`. You can configure where files `WeNNI.jar` and
     61the `nni` will be installed using `with-plugindir=DIR`. Files will be
     62installed in `<DIR>/se/lu/thep/wenni/`. Default `DIR` is set to
     63`path/to/base/www/plugins/`. You may use `with-gsl=DIR` to provide
     64information on GSL location. The option `enable-debug` turns on debug
     65options on the compilation of binary `nni` (e.g. enables assertions).
     66
     67 3. Now build using
     68    $ `make`
     69
     70 If all went well `nni` created in directory `bin/nni` as well as
     71`WeNNI.jar` in directory `base/base2/`.
     72
     73 4. Optionally, run the test program
     74    $ make check
     75
     76 5. Install files using
     77    $ make install
     78
     79 6. Make BASE aware of the plugin, see BASE documentation
     80 http://base.thep.lu.se/chrome/site/doc/html/index.html
     81
     82
     83
     84
     85pre-requisite:
    3586
    3687Mandatory:
Note: See TracChangeset for help on using the changeset viewer.