Projects/Edu/KStars/Building KStars KF5: Difference between revisions

Revision as of 06:59, 10 January 2016

This page is a community effort to document the procedure to build the KDE Frameworks 5 version of KStars on various platforms and environments. We have a separate page for the old KDE4 version.

Why build from source?

Typically, you would want to build KStars from source if you plan to develop KStars, or stay on the bleeding edge and contribute valuable feedback.

Integrated Development Environment (IDE)

If you plan to develop KStars, it is highly recommended to utilize an IDE. You can use any IDE of your choice, but QtCreator or KDevelop are recommended as they are more suited for Qt/KDE development.

Prerequisite Packages

To build and develop KStars, several packages may be required from your distribution. Here's a list.

Required dependencies

GNU Make, GCC -- Essential tools for building
cmake -- buildsystem used by KDE
Qt Library > 5.2.0
Several KDE Frameworks: KConfig, KDocTools, KGuiAddons, KWidgetsAddons, KNewStuff, KI18n, KInit, KIO, KXmlGui, KPlotting, KIconThemes
eigen -- linear algebra library
zlib -- compression library

Optional dependencies

libcfitsio -- FITS library
libindi -- Instrument Neutral Distributed Interface, for controlling equipment.
xplanet

Installing these packages

To install all of these, use the following commands:

Debian / Kubuntu

  sudo apt-get install build-essential cmake qtdeclarative5-dev libkf5config-dev kdoctools-dev libkf5guiaddons-dev libkf5widgetsaddons-dev libkf5newstuff-dev libkf5dbusaddons-dev libkf5i18n-dev libkf5init-dev libkf5jobwidgets-dev kio-dev libkf5windowsystem-dev libkf5xmlgui-dev libkf5plotting-dev libkf5texteditor-dev libkf5iconthemes-dev libeigen3-dev libcfitsio3-dev zlib1g-dev libindi-dev

Arch Linux

   sudo pacman -S eigen libindi wcslib cmake kf5

Fedora

   yum install cfitsio-devel eigen3-devel cmake extra-cmake-modules.noarch kf5-kconfig-devel kf5-kdbusaddons-devel kf5-kdoctools-devel kf5-kguiaddons-devel kf5-ki18n-devel kf5-kiconthemes-devel kf5-kinit-devel kf5-kio-devel kf5-kjobwidgets-devel kf5-knewstuff-devel kf5-kplotting-devel kf5-ktexteditor-devel kf5-kwidgetsaddons-devel kf5-kwindowsystem-devel kf5-kxmlgui-devel libindi-devel libindi-static qt5-qtdeclarative-devel qt5-qtmultimedia-devel qt5-qtsvg-devel wcslib-devel xplanet zlib-devel

Documentation on building various versions

Git

KStars development happens on KDE's git repository. (Git is an open-source version control software.). The code on git is the bleeding-edge developers' version of KStars. It it mostly stable, but occasionally breaks.

Create and change into a KDE development directory:

  mkdir ~/kde && cd ~/kde

Fetch the KStars source code:

  git clone git://anongit.kde.org/kstars

Create and change into a build directory for compilation:

  mkdir build && cd build

Run the configure process with cmake:

  cmake ../kstars -DCMAKE_INSTALL_PREFIX=/usr/bin

Compile KStars:

  make

6) Install KStars:

  make install

That’s all! This installs KStars globally, so if you have an existing KStars, it will overwrite it.

You can keep your copy up-to-date by typing `git pull --rebase` in ~/kde/kstars. Feel free to send patches to our mailing list [email protected]. And join #kde-kstars on irc.kde.org :–)

@@ Line 38: / Line 38: @@
 == Documentation on building various versions ==
 === Git ===
-KStars development happens on KDE's git repository. ([http://git-scm.com Git] is an open-source version control software.). The code on git is the bleeding-edge developers' version of KStars. It does break occasionally.
+KStars development happens on KDE's git repository. ([http://git-scm.com Git] is an open-source version control software.). The code on git is the bleeding-edge developers' version of KStars. It it mostly stable, but occasionally breaks.
-) create and change into a KDE development directory:
+# Create and change into a KDE development directory:
-    mkdir ~/kde; cd ~/kde
+    mkdir ~/kde && cd ~/kde
-) to fetch the KStars source code:
+# Fetch the KStars source code:
     git clone git://anongit.kde.org/kstars
-) create and change into a build directory for compilation:
+# Create and change into a build directory for compilation:
-    mkdir build; cd build
+    mkdir build && cd build
-) run the configure process with cmake:
+# Run the configure process with cmake:
-    cmake ../kstars -DCMAKE_INSTALL_PREFIX=~/kde/usr
+    cmake ../kstars -DCMAKE_INSTALL_PREFIX=/usr/bin
-) compile KStars:
+# Compile KStars:
     make
-) finally install KStars:
+) Install KStars:
     make install
-That’s all! This installs KStars locally into the separate directory ~/kde/usr, so that your global KDE installation will not be touched at all.
+That’s all! This installs KStars globally, so if you have an existing KStars, it will overwrite it.
-<!-- THIS HAS TO BE UPDATED
-Now on to starting the newly compiled KStars. Create a file ~/kde/run.sh with the following content:
+You can keep your copy up-to-date by typing `git pull --rebase` in ~/kde/kstars. Feel free to send patches to our mailing list [email protected]. And join #kde-kstars on irc.kde.org :–)
-  #!/bin/bash
-  export KSTARS_DIR=~/kde/usr
-  export PATH=$KSTARS_DIR/bin:$PATH
-  export LD_LIBRARY_PATH=$KSTARS_DIR/lib:$LD_LIBRARY_PATH
-  export KDEDIR=$KSTARS_DIR
-  export KDEDIRS=$KDEDIR
-  export XDG_DATA_DIRS=$XDG_DATA_DIRS:$KSTARS_DIR/share
-  # update KDE's system configuration cache
-  kbuildsycoca4
-  # start app
-  $@
-Make the script executable with chmod 755 ~/kde/run.sh. Now you can run the compiled KStars version with `~/kde/run.sh kstars`. Just calling `kstars` directly will start the system version of KStars.
--->
-You can keep your copy up-to-date by typing `git pull --rebase` in ~/kde/kstars. Feel free to send patches to our mailing list [email protected]. And join #kde-edu on irc.kde.org :–)