Requirements
==================

RKWard requires:
- KDE-libraries and headers (>= 3.x) (http://www.kde.org)
- Qt-libraries and headers (>= 3.x) (http://www.trolltech.com)
- R and headers (http://www.r-project.org)
- PHP with commandline-interface (http://www.php.net)


Compilation
==================

IMPORTANT: You will need to have the R shared library installed. This is typically located in a place like /usr/lib/R/lib/libR.so. Unfortunately, some distributions do not yet ship their R binary with the shared library. In those (rare) cases, you'll have to compile and install R on your own with the option --enable-R-shlib.

Compilation / installation is basically just a

# ./configure
# make
# make install

and in 95% of the cases this should be all you need. Here are some ./configure options you may need to set in the other 5%:

--prefix=/path/to/kde

defaults to 1) $KDEDIR or if that is not set 2) the output of "kde-config --prefix". If you have multiple versions of KDE installed, or need to specify the kde-directory for any other reason, you need to set this option explicitely.

One some systems you might also have to specify your qt (3) directory, passing the commandline-option
--with-qt-dir=/usr/lib/qt3			(or similar)
to configure.

The options
--with-r-home
--with-r-includes
--with-r-libdir
can be used to configure the details of your R installation. Usually these settings should be detected automatically, but especially if you have several versions of R installed, these may be relevant. NOTE: --with-r-libdir does not refer to the location of the shared R library, but rather to where the rkward R package should be installed to. By default, the first entry in .libPaths () will be used, (typically something like /usr/lib/R/site-library), but in case you keep several dedicated library paths, this allows you to specify, which one to install to.


Installation
==================

You _have to_ install RKWard. Otherwise RKWard will be missing important menu-options, may behave strangely, or may not run at all.
As root run:
# make install

Make sure you have set the correct path in ./configure (the --prefix=... option)


Running
==================

For now it's recommended to run RKWard from the command-line for debug-output. For the few available command-line options see

# rkward --help