Skip to content

PlexyDesk Build Guide

Siraj Razick edited this page Mar 11, 2015 · 4 revisions

Build Requirements.

  • Qt 5.3 or higher. (the current code base can compile with Qt5.2, but the release will be targeted for 5.3 or higher).
  • cmake 3.x
  • clang, gcc or Windows 7 or 8 SDK

Optional Requirements.

  • Flicker Key for building Facebook components. pass the key when building with -DSOCIAL_KIT_FLICKR_API_KEY="xxxxx"
  • DropBox Developer Key with : -DSOCIAL_KIT_DROPBOX_API_KEY="xxxx"

Getting PlexyDesk source files:

You can get PlexyDesk sources via two methods:

METHOD 1:

  1. Go to a folder of your choice where you will build PlexyDesk. For example /tmp/plexy
  2. git clone git@github.com:plexydesk/plexydesk.git
  3. cd plexydesk

METHOD 2:

  1. Go to a folder of your choice where you will build PlexyDesk. For example /tmp/plexy
  2. Get the source tarball from our download page - http://www.plexyplanet.org/download#source
  3. tar xjvf plexydesk-X.X.X.tar.bz2 where X.X.X is the version number of PlexyDesk
  4. cd plexydesk-X.X.X where X.X.X is the version number of PlexyDesk

Both methods will lead you in the sources root folder. Next continue with building depending on what you are after.

NOTE: Have in mind that the best way to install PlexyDesk is using your distribution native package system. PlexyDesk now supports building packages for these distributions (see howto do it below): - Mandriva - openSuSE - Fedora - PCLinuxOS* - Ubuntu - Debian and its derivatives

Building On Linux (debug mode):

This is valid for all distributions. From sources root folder do:

mkdir build
cd build
cmake ../ -DCMAKE_INSTALL_PREFIX:STRING=/usr -DCMAKE_BUILD_TYPE:STRING=Debug -DCMAKE_VERBOSE_MAKEFILE:BOOL=true -DCMAKE_CXX_FLAGS_DEBUG:STRING="-g -O0"
make
sudo make install

Building On Linux (release mode):

This is valid for all distributions. From sources root folder do:

mkdir build
cd build
cmake ../ -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release
make
sudo make install

Building a Debian/Ubuntu package on Linux:

This can be done if your distribution is a Debian derivative. From sources root folder do:

dist/make_dist_deb.sh

and follow the instructions. When the plexydesk_X.X.X_YYYY.deb is ready you may install it using the deb standard command:

dpkg -i INSTALLERS/deb/plexydesk_X.X.X_YYYY.deb

NOTE: If some of the dependencies are not satisfied, use your package manager to install them first and then do the "dpkg -i plexydesk_X.X.X_YYYY.deb" again.

Building an RPM package on Linux:

This can be done if your distribution is an RPM distribution. Currently PlexyDesk supports building RPMs for these distributions:

  • Mandriva
  • openSuSE
  • Fedora
  • Ubuntu
  • Debian and its derivatives

If you know for sure that your distribution is an RPM one, but it is not in the above list, please try this method first and it may work due to the included support even of unknown RPM distros.

First be sure you have already installed the rpm-build package. Next from sources root folder do:

dist/make_dist_rpm.sh

and follow the instructions. When the plexydesk-X.X.X-YYYYYYY.rpm is ready you may install it using the rpm standard command:

rpm -ivp INSTALLERS/rpm/plexydesk-X.X.X-YYYYYYY.rpm

NOTE: If some of the dependencies are not satisfied, use your package manager to install them first and then do the "rpm -ivp plexydesk-X.X.X-YYYYYYY.rpm" again.

Building On Windows:

To compile PlexyDesk on Windows following tools needs to be installed on your system. Currently All version of windows supported by Qt is supported by PlexyDesk too.

  • Visual Studio express 2013 - (Older versions will not due to lack of C++11 extensions and support)
  • CMake for Windows.
  • Git for Windows or Github UI for Windows.
  • Qt 5.3 or later which matches your compilers.

Give the above tools are installed start up Make sure the tools are available from Visual Studio Command Line runtime console.

$> git clone https://github.com/plexydesk/plexydesk
$> cd plexydesk
$> mkdir plexydesk-1.0-release-build
$> cd plexydesk-1.0-release-build
$> cmake -G "NMake Makefiles" -DCMAKE_INSTALL_PREFIX="C:\PlexyDesk-1.0\
$> nmake
$> nmake install
$> windeployqt -xml -webkit2 -webkitwidgets -webkit -network -svg -opengl -multimedia -quick -printsupport -multimediawidgets -sensors -sql -positioning c:\PlexyDesk-1.0\bin\plexydesk.exe
$> C:\PlexyDesk-1.0\bin\plexydesk.exe 
Please note that due to bug #32 you might need to copy all the DLL files from lib to bin directory. please avoid
copying lib\extensions since they will be resolved and loaded by plexyesk.

Building On Blackberry 10 SDK:

You need to download the blackberry 10 NDK from the blackberry developer portal. (currently this is free). after insalling the SDK excute the following commands to compile plexydesk for blackberry 10.

- source ~/bbndk/bbndk-env.sh
- cmake -DCMAKE_TOOLCHAIN_FILE=../tools/Toolchain-QNX-6.4.1.cmake -DCMAKE_INSALL_PREFIX=~/bbroot/plexydesk
- make -j 8
- make install : when the install finishes you will find the compiled binaries in ~/bbroot/plexydesk
- now you can create a bar file and upload it to your devce.

Debugging of PlexyDesk

If you need a debug output from PlexyDesk, you have two methods:

METHOD 1:

PlexyDesk if built in Debugging Mode, will create a log file in your temp folder (depending on your platform) that will be named plexydesk_log_DATE-TIME.txt You can see the output in this file.

METHOD 2:

You may debug PlexyDesk (only if built in Debugging Mode) by starting it in console (any platform) and using the environment variable: PLEXYDESK_CONSOLE_DEBUG. Set it to "enable", "true" or 1 (all are case insensitive). For Windows for example do it by issuing this command on the command line of your Command prompt: SET PLEXYDESK_CONSOLE_DEBUG=true

  • Coding Guidelines

Clone this wiki locally