Warning, /education/rkward/INSTALL is written in an unsupported language. File is not indexed.

0001 Requirements
0002 ===================
0003 
0004 RKWard requires:
0005 - Several KF5-libraries and headers (>= 5.4) (https://www.kde.org)
0006 - Qt-libraries and headers (>= 5.2) (http://www.trolltech.com)
0007 - R and headers (https://www.r-project.org)
0008 - CMake (https://cmake.org)
0009 
0010 
0011 Compilation
0012 ===================
0013 
0014 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.
0015 
0016 The recommended way to build from source is:
0017 > mkdir build; cd build
0018 > cmake path_to_rkward_sources [options]        # see below
0019 > make
0020 > sudo make install
0021 
0022 
0023 CMake options (configuring)
0024 ===================
0025 
0026 The cmake command offers a number of parameters to control the build process. Some commonly needed are:
0027 
0028 -DCMAKE_INSTALL_PREFIX
0029         set the installation base directory. Generally -DCMAKE_INSTALL_PREFIX=`kde4-config --prefix` should be correct.
0030 -DCMAKE_BUILD_TYPE
0031         type of build. Useful settings include -DCMAKE_BUILD_TYPE=Release and -DCMAKE_BUILD_TYPE=debugfull
0032 
0033 In some cases you may want to set the following options:
0034 
0035 -DNO_QT_WEBENGINE
0036         By default QWebEngine is used for HTML rendering, if available in version >= 5.12.0. Otherwise QtWebKit is used. You can
0037         force compilation for QtWebKit by setting: -DNO_QT_WEBENGINE=1
0038 -DR_EXECUTABLE
0039         path to the R executable. You may want to set this, if you have multiple versions of R installed, or R is not in your path. Example: -DR_EXECUTABLE=/usr/bin/R
0040 -DR_HOME
0041         R home directory. Almost certainly this option is not needed.
0042 -DR_INCLUDEDIR
0043         path to R include files. Almost certainly this option is not needed.
0044 -DUSE_BINARY_PACKAGES
0045         Currently only interpreted on Mac OS: If RKWard should default to installing binary R packages (if available) use
0046         -DUSE_BINARY_PACKAGE=1. Otherwise, RKWard will default to building R packages from source.
0047 -DTRANSLATION_SRC_CIR
0048         If you have imported translation source files (.po-files) to a separate directory, you can specify this, here.
0049 
0050 Further generic options are listed on http://www.cmake.org/Wiki/CMake_Useful_Variables .
0051 
0052 
0053 Installation
0054 ==================
0055 
0056 As a last step, you _have to_ run 'make install'. Otherwise RKWard will be missing important menu-options, may behave strangely, or may not run at all.
0057 As root run:
0058 > make install
0059 
0060 Make sure you have set the correct path in cmake (the -DCMAKE_INSTALL_PREFIX option).
0061 
0062 
0063 Running
0064 ==================
0065 
0066 For now it's recommended to run RKWard from the command-line for debug-output. For the few available command-line options see
0067 
0068 > rkward --help
0069 
0070 If an error occurs directly after starting, this will typically indicate a problem in your installation. In this case, please make sure, you have followed all above instructions diligently.
0071 
0072 
0073 Automated tests
0074 ==================
0075 
0076 A series of automated functionality tests can be run unsing 'make plugintests' *after* completing the installation. Unfortunately, these tests are rather prone to false alarms, and thus end users are not currently encouraged to run the tests. However, esp. developers, and packagers patching the sources should run 'make plugintests' after doing their changes. For failed tests, please take some time trying to understand, exactly how the test failed. Often it's just a harmless difference in rounding or formatting of output.
0077 
0078 If you see a genuine test failure, unrelated to your patches, please report this to rkward-devel AT kde DOT org, including details on your installed versions of KDE, R, and RKWard.