Changeset 413

Timestamp:

Aug 30, 2007, 6:25:24 PM (16 years ago)

Author:

Peter Johansson

Message:

adding INSTALL instructions for BASE1 and Stand-alone. refs #53

File:

• trunk/se/lu/thep/wenni/INSTALL (modified) (2 diffs)

trunk/se/lu/thep/wenni/INSTALL

@@ -57 +57 @@
 The configure script accepts a few options that may be of
 interest. You can provide `./configure` with BASE location information
-with `--with-basedir=DIR`. This information is used to find jar files
+with `--with-basedir=BASEDIR`. This information is used to find jar
+files such as `BASE2Core.jar`. Files `WeNNI.jar` and `nni` will be
+installed in `<BASEDIR>/www/plugins/se/lu/thep/wenni/`. Installation
+directory can be changed by using `./configure` option
+`with-plugindir=DIR`.
+
+
+You can configure where files `WeNNI.jar` and
+the `nni` will be installed using `with-plugindir=DIR`. Files will be
+installed in `<DIR>/se/lu/thep/wenni/`. Default `DIR` is set to
+`path/to/base/www/plugins/`. You may use `with-gsl=DIR` to provide
+•information on GSL location. The option `enable-debug` turns on debug
+options on the compilation of binary `nni` (e.g. enables assertions).
+
+ 3. Now build using 
+    $ `make`
+
+If all went well `nni` created in directory `bin/nni` as well as
+`WeNNI.jar` in directory `base/base2/`.
+
+ 4. Optionally, run the test program
+    $ `make check`
+
+ 5. Install files using 
+    $ `make install`
+
+ 6. Make BASE aware of the plugin, see BASE documentation
+ http://base.thep.lu.se/chrome/site/doc/html/index.html
+
+
+= BASE 1 mode =
+
+== Pre-requisite ==
+
+ 1. Download and install GSL, http://www.gnu.org/software/gsl/.
+ 2. Perl, http://www.cpan.org/.
+ 3. A working BASE1 installation.
+
+== WeNNI install ==
+
+ 1. Download and unpack WeNNI. `cd` to the root directory of the distribution.
+
+ 2. Run configure script with 
+    $ `./configure --enable-state=base1`
+
+The configure script accepts a few options that may be of
+interest. You can provide `./configure` with BASE location information
+with `--with-basedir=BASEDIR`. This information is used to find base library
+and header file. Header file `basefile.h` is expected to be found in 
+`<BASEDIR>/BASE-plugindevkit/bogus_base/include/cxx/`. 
+
+
+This information is used to find jar files
 such as `BASE2Core.jar`. You can configure where files `WeNNI.jar` and
 the `nni` will be installed using `with-plugindir=DIR`. Files will be
@@ -80 +132 @@
  http://base.thep.lu.se/chrome/site/doc/html/index.html
 
-
-= BASE 1 mode =
-
-== Pre-requisite ==
-
- 1. Download and install GSL, http://www.gnu.org/software/gsl/.
- 2. Perl, http://www.cpan.org/.
- 3. A working BASE1 installation.
-
-== WeNNI install ==
 
 pre-requisite: