Projects/Edu/Rocs: Difference between revisions

Latest revision as of 09:17, 18 December 2012

Checklist for Development Environment

The following steps are mandatory:

setup development enviroment for KDE applications
get Rocs source code
configure Rocs build system
compile Rocs
install Rocs
set KDEDIRS and run kbuildsycoca4
run Rocs

Now, the important sections in more detail:

Rocs Development Environment

Usually it is not necessary to compile kdelibs and Qt from source to be able to compile Rocs. The current master branch of Rocs only requires development packges of the following framewoks:

KDE >= 4.7
Qt >= 4.7
Boost >= 1.49 (note that the libboost-graph package is also needed)

Those package are usually indicated by a trailing "-dev" in the package name, as provided by your favorite distribution.

Development Packages on Debian

kde-sc-dev-latest
cmake
kdelibs5-dev
libboost-dev
libboost-graph-dev
libboost-graph1.49.0

Get the Rocs Source Code

You can fetch the sources from the Rocs Project Page by cloning the Git repository. Let's say you fetch the source to: "$HOME/rocs-source"

Configure Your Build-System

Next, we need folders for building and for installing Rocs. Let's say

$HOME/rocs-build
$HOME/rocs-install

Then we need to say the build-scripts that those folders exist. Very comfortable this can be done by using the program cmake-gui. Take care to set the following:

Source-directory is: $HOME/rocs-source
Build-directory is: $HOME/rocs-build
set: CMAKE_BUILD_TYPE = debugfull
set: CMAKE_INSTALL_PREFIX = $HOME/rocs-install

Then press "configure" to see if all necessary libraries are present. Finally generate make-files if nothing is red anymore.

Setup Execution Enviroment and Run Rocs

It is necessary that the following two steps are done:

export KDEDIRS=$HOME/rocs-install:$KDEDIRS
kbuildsycoca4

Finally, you can run Rocs by executing the compiled and installed binary in $HOME/rocs-install.

@@ Line 1: / Line 1: @@
-== Getting Started ==
+== Checklist for Development Environment==
 The following steps are mandatory:
-# get source
+# setup development enviroment for KDE applications
-# configure your build system with CMake
+# get Rocs source code
+# configure Rocs build system
 # compile Rocs
 # install Rocs
-# setup your KDEDIRS path and run kbuildsycoca4
+# set KDEDIRS and run kbuildsycoca4
 # run Rocs
-Now the steps with more details:
+Now, the important sections in more detail:
-=== Get the Source ===
+=== Rocs Development Environment ===
-You can fetch the sources by an [[Getting_Started/Sources/Anonymous_SVN|Anonymous SVN]] account. (Note: switch from SVN to GIT is expected in the very near future) Let's say you fetch the source to: "$HOME/rocs-source"
+Usually it is '''not necessary''' to compile kdelibs and Qt from source to be able to compile Rocs. The current master branch of Rocs only requires development packges of the following framewoks:
+* KDE >= 4.7
+* Qt >= 4.7
+* Boost >= 1.49 (note that the libboost-graph package is also needed)
+Those package are usually indicated by a trailing "-dev" in the package name, as provided by your favorite distribution.
+==== Development Packages on Debian ====
+* kde-sc-dev-latest
+* cmake
+* kdelibs5-dev
+* libboost-dev
+* libboost-graph-dev
+* libboost-graph1.49.0
+=== Get the Rocs Source Code ===
+You can fetch the sources from the [https://projects.kde.org/projects/kde/kdeedu/rocs/repository Rocs Project Page] by cloning the Git repository. Let's say you fetch the source to: "$HOME/rocs-source"
 === Configure Your Build-System ===
@@ Line 24: / Line 40: @@
 Then press "configure" to see if all necessary libraries are present. Finally generate make-files if nothing is red anymore.
-=== Run Rocs ===
+=== Setup Execution Enviroment and Run Rocs===
 It is necessary that the following two steps are done:
-# export KDEDIRS=$HOME/rocs-install:/$KDEDIRS
+# export KDEDIRS=$HOME/rocs-install:$KDEDIRS
 # kbuildsycoca4
 Finally, you can run Rocs by executing the compiled and installed binary in $HOME/rocs-install.