[websites/rkward-kde-org] /: Update, simplifications, and formatting.
Thomas Friedrichsmeier
null at kde.org
Sat Oct 3 11:16:20 BST 2020
Git commit 1691a8fe68010b85522dc1a956bc3c6c44b685e7 by Thomas Friedrichsmeier.
Committed on 03/10/2020 at 10:16.
Pushed by tfry into branch 'master'.
Update, simplifications, and formatting.
M +38 -81 Building_RKWard_From_Source.md
https://invent.kde.org/websites/rkward-kde-org/commit/1691a8fe68010b85522dc1a956bc3c6c44b685e7
diff --git a/Building_RKWard_From_Source.md b/Building_RKWard_From_Source.md
index 0516e7f..6bd5f63 100644
--- a/Building_RKWard_From_Source.md
+++ b/Building_RKWard_From_Source.md
@@ -4,9 +4,6 @@ layout: page
# Building RKWard from Source
-The purpose of this page is to give you step-by-step instructions to
-compile and install RKWard from sources.
-
**Note**: These are generic instructions, which should work on most
systems. However, for many systems, more detailed instructions, or even
ready-made binary packages are available. See
@@ -15,19 +12,11 @@ ready-made binary packages are available. See
**Note**: For instructions on compiling the KDE 4 versions of RKWard
(before RKWard 0.7.0), please refer to [an older version of this page](https://web.archive.org/web/20170324162924/https://rkward.kde.org/Building_RKWard_From_Source).
-## Contents of this page:
-
-* Table of contents
-{:toc}
-
## Getting the source code
- - [Available source packages](Download_RKWard.html)
- - [Getting the source from git](RKWard_Source_Repository.html)
+Refer to [Available source packages](Download_RKWard.html) **or** [Getting the source from git](RKWard_Source_Repository.html).
-## Building RKWard
-
-### Requirements
+## Installing required dependencies
RKWard requires:
@@ -54,16 +43,11 @@ look at
[Binaries_and_Build_Scripts](Binaries_and_Build_Scripts.html)
for distribution specific information, or [contact us](Contact.html) for help.
-Debian derivatives:
-
- - On Debian based systems (such as Ubuntu) the following will get all
- the dependencies installed (and hopefully the package names will be
- similar on other distributions):
+On Debian based systems (such as Ubuntu) the following will get all the dependencies installed (and hopefully the package names will be similar on other distributions):
-$ apt-get install libkf5webkit-dev libkf5texteditor-dev kdoctools-dev
-r-base-dev cmake extra-cmake-modules
+`apt-get install libkf5webkit-dev libkf5texteditor-dev kdoctools-dev r-base-dev cmake extra-cmake-modules`
-### Compilation
+## 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,
@@ -71,72 +55,46 @@ 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.
-Suppose the source is obtained as (here **rkward-0.7.0.tar.gz** is used
-as an example, change it accordingly): $ tar xzf rkward-0.7.0.tar.gz \#
-extracts to **rkward-0.7.0** directory $ cd rkward-0.7.0
-
-Then, the recommended way to build from source is: $ mkdir build; cd
-build $ cmake .. \[options\] \# see *Path to sources* and *CMake
-options* below $ make $ sudo make install
-
-#### Path to sources
-
-The cmake command needs to know the path to rkward sources. Typically
-this where the CMakeLists.txt file exists. Since, in the example above,
+Suppose the source is obtained as **rkward-0.7.2.tar.gz** (here, version 0.7.2 is used
+as an example, change it accordingly). Then, the recommended steps to build from source are:
+```
+tar xzf rkward-0.7.2.tar.gz # extracts to "rkward-0.7.0" directory
+cd rkward-0.7.2
+mkdir build # dedicated build directory is recommended, but not required
+cd build
+cmake .. [options] # see *CMake options* below
+make -j 5 # the j parameter specifies the number of parallel units to compile;
+ # on systems with many cores, a higher value will speed up the build
+sudo make install
+```
+
+### CMake options (configuring)
+
+The first paramter to cmake is the path to the rkward sources. In the example above,
the build directory was created inside the extracted source directory,
-CMakeLists.txt exists in the directory immediately above; hence **'..**'
-is the appropriate path.
-
-#### CMake options (configuring)
+CMakeLists.txt exists in the directory immediately above; hence ".."
+is the appropriate path in this setup.
-The cmake command offers a number of parameters to control the build
+A number of parameters may be specified to control the build
process. Some commonly needed are:
- - \-DCMAKE_INSTALL_PREFIX
+ - `-DCMAKE_INSTALL_PREFIX`
- set the installation base directory. Generally
- -DCMAKE_INSTALL_PREFIX=\`kde5-config --prefix\` should be
+ ```-DCMAKE_INSTALL_PREFIX=`kde5-config --prefix` ``` should be
correct.
-
-<!-- end list -->
-
- - \-DCMAKE_BUILD_TYPE
+ - `-DCMAKE_BUILD_TYPE`
- type of build. Useful settings include
- -DCMAKE_BUILD_TYPE=Release and -DCMAKE_BUILD_TYPE=debugfull
+ `-DCMAKE_BUILD_TYPE=Release` and `-DCMAKE_BUILD_TYPE=debugfull`
In some cases you may want to set the following options:
- - \-DR_EXECUTABLE
- - path to the R executable. You may want to set this, if you have
+ - `-DR_EXECUTABLE`
+ - path to the R executable to build for. 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
- - \-DR_LIBDIR
- - directory where R packages should be installed. This option is
- mainly of interest to packagers.
- - When installing as a normal user (i.e., w/o root access), this
- needs to be explicitely specified. Generally this is the
- R_LIBS_USER variable from the Renviron file which can be
- identified from withing R using:
-
-$ R --silent \> Sys.getenv ("R_LIBS_USER").
-
-` R_LIBS_USER`
-
-"\~/R/i486-pc-linux-gnu-library/2.9"
-
- -
-
- -
- For example, on a i386 Debian with R 2.9,
- \~/R/i486-pc-linux-gnu-library/2.9 is the default. Create the
- directory manually, if it doesn't exist: **mkdir -p
- \~/R/i486-pc-linux-gnu-library/2.9** . Then, using
- -DR_LIBDIR=$HOME/R/i486-pc-linux-gnu-library/2.9 should work.
-
-<!-- end list -->
-
- - \-DR_HOME
+ Example: `-DR_EXECUTABLE=/usr/bin/R`
+ - `-DR_HOME`
- R home directory. Almost certainly this option is not needed.
- - \-DR_INCLUDEDIR
+ - `-DR_INCLUDEDIR`
- path to R include files. Almost certainly this option is not
needed.
@@ -145,19 +103,18 @@ Further generic options are listed on
### Installation
-As a last step, you _have to_ run 'make install'. Otherwise RKWard
+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. As root run: $ make install
+run at all. As this will require admin permissions, use: `sudo make install`
-Make sure you have set the correct path in cmake (the
--DCMAKE_INSTALL_PREFIX option).
+Make sure you have set the correct path in cmake (the `-DCMAKE_INSTALL_PREFIX` option).
-### Running
+## 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
+`rkward --help`
## Troubleshooting
More information about the rkward-tracker
mailing list