README 1.95 KB
Newer Older
Titta Heikkala's avatar
Titta Heikkala committed
---------------
Titta Heikkala's avatar
Titta Heikkala committed
---------------
samakkon's avatar
samakkon committed

Titta Heikkala's avatar
Titta Heikkala committed
Qt Charts module provides a set of easy to use chart components. It uses
the Qt Graphics View Framework, therefore charts can be easily integrated
to modern user interfaces.

System Requirements
Miikka Heikkinen's avatar
Miikka Heikkinen committed
===================
samakkon's avatar
samakkon committed

Titta Heikkala's avatar
Titta Heikkala committed
- Qt 5.4 or newer
- For QML applications QtQuick 2 is required
Titta Heikkala's avatar
Titta Heikkala committed
- Manipulating Qt Charts graphs with QML Designer requires Qt Creator 3.3 or newer
samakkon's avatar
samakkon committed

Michal Klocek's avatar
Michal Klocek committed
Building
samakkon's avatar
samakkon committed
========
Titta Heikkala's avatar
Titta Heikkala committed
Configure the project with qmake:
    qmake
samakkon's avatar
samakkon committed

Titta Heikkala's avatar
Titta Heikkala committed
After running qmake, build the project with make:
    (Linux) make
Michal Klocek's avatar
Michal Klocek committed
    (Windows with MinGw) mingw32-make
Titta Heikkala's avatar
Titta Heikkala committed
    (Windows with Visual Studio) nmake
    (OS X) make

The above generates the default makefiles for your configuration, which is typically
the release build if you are using precompiled binary Qt distribution. To build both
debug and release, or one specifically, use one of the following qmake lines instead.
samakkon's avatar
samakkon committed

Michal Klocek's avatar
Michal Klocek committed
For debug builds:
Titta Heikkala's avatar
Titta Heikkala committed
    qmake CONFIG+=debug
    make
  or
    qmake CONFIG+=debug_and_release
    make debug

For release builds:
    qmake CONFIG+=release
    make
  or
    qmake CONFIG+=debug_and_release
    make release

For both builds (Windows/OS X only):
    qmake CONFIG+="debug_and_release build_all"
    make

After building, install the module to your Qt directory:
Michal Klocek's avatar
Michal Klocek committed
    make install
samakkon's avatar
samakkon committed

Titta Heikkala's avatar
Titta Heikkala committed
If you want to uninstall the module:
Michal Klocek's avatar
Michal Klocek committed
    make uninstall
samakkon's avatar
samakkon committed

Building as a statically linked library
=======================================

Titta Heikkala's avatar
Titta Heikkala committed
The same as above applies, you will just have to add static to the CONFIG:
    qmake CONFIG+=static
samakkon's avatar
samakkon committed
Documentation
=============
Titta Heikkala's avatar
Titta Heikkala committed
The documentation can be generated with:
Tero Ahola's avatar
Tero Ahola committed
    make docs
samakkon's avatar
samakkon committed

Titta Heikkala's avatar
Titta Heikkala committed
The documentation is generated into the doc folder under the build folder.
Both Qt Assistant (qtcharts.qch) and in HTML format (qtcharts subfolder)
documentation is generated.

Please refer to the generated documentation for more information:
    doc/qtcharts/qtcharts-index.html
Titta Heikkala's avatar
Titta Heikkala committed

Known issues
============

- Zooming too far or too close may eventually freeze the zooming and scrolling.