C++ C# Objective-C C HTML Makefile Other
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Build Status

Table of Contents

Build instructions

Please check OS specific requirements below.

By default the app builds for testing server. To use the compiled app with live server see this guide https://github.com/toggl/toggldesktop/wiki/Building-Toggl-Desktop-from-source-for-usage-with-live-servers

Build using Makefile

First, build dependencies:

make deps

then the app itself:

make

To build, then run the app:

make run

Run unit tests with

make test

and UI tests with

make uitest

Linux

You'll need QT to be at least version 5.5

If qmake is not on your PATH, set this first, before running make:

export QMAKE=/usr/bin/qmake-qt5

Below are some distribution specific package requirements:

Debian

  • libreadline-dev
  • qt5-default
  • libxss-dev
  • libqt5x11extras5-dev
  • libqt5webkit5-dev

Ubuntu

  • libreadline-dev
  • xorg-dev
  • qtcreator
  • libxss-dev
  • libqt5webkit5-dev
  • libqt5x11extras5-dev
  • qtbase5-private-dev

Fedora

  • readline-devel
  • qt5-qtwebkit-devel
  • libXScrnSaver-devel
  • qt5-qtsvg

Windows

Install dev tools

We're building the Windows app using Visual Studio Community 2013 - it's a free download

You'll need to install ActivePerl to build OpenSSL from source.

If you plan to run tests then you might want to install Cygwin.

Build OpenSSL

Use pre-built OpenSSL binaries (recommended)

Clone OpenSSL distribution provided by Poco project under the poco directory

cd %POCO_BASE%
git clone https://github.com/pocoproject/openssl

Or

build OpenSSL, from Visual Studio Tools, open up a Developer Command Prompt.

cd to the project folder, then

cd third_party\openssl
perl Configure VC-WIN32
ms\do_nasm
nmake -f ms\ntdll.mak clean
nmake -f ms\ntdll.mak 

Instead of do_nasm (use NASM) you can also use do_ms (no asm at all), or do_masm (use MASM). NASM can be downloaded here: http://www.nasm.us/pub/nasm/releasebuilds/?C=M;O=D

Build the app

Now, select Release from the Solution Configurations combobox in the Visual Studio toolbar, and build the solution.

If you have Cygwin installed, you can also build the app from from Cygwin terminal, using make. (See macOS and Linux build instructions on above regarding make).

Downloads

macOS

Toggl built and signed app for macOS is available for download. You need at least macOS 10.8.

Windows

Toggl built and signed app for Windows is available for download. App has been tested on Windows 7, 8, 8.1 and 10.

Toggl Desktop Windows app has not been tested on Surface type touchscreen environments.

Linux (64 bit only)

Change log

Change log can be viewed at http://toggl.github.io/toggldesktop/

Documentation

The documentation of the code base is currently work in progress and can be found at /docs/.

Contribute

Before sending us a pull request, please format the source code:

make fmt

Also, please check for any cpplint issues:

make lint

Check if unit tests continue to pass:

make test