forked from romixlab/qmsgpack
87 lines
1.7 KiB
ReStructuredText
87 lines
1.7 KiB
ReStructuredText
Installation
|
|
------------
|
|
|
|
.. contents::
|
|
:depth: 4
|
|
|
|
qmsgpack is a pure Qt library (Qt4 and Qt5 supported), so you can build it for almost any platform Qt supports.
|
|
Also there are several build options:
|
|
|
|
- CMake
|
|
- qmake
|
|
|
|
And two ways of using it: build separately and include to your project, or build with your project (qmake subdirs)
|
|
|
|
Build
|
|
=====
|
|
|
|
CMake
|
|
^^^^^
|
|
|
|
Get the latest qmsgpack version by grabbing the source code from GitHub:
|
|
|
|
.. code-block:: bash
|
|
|
|
$ git clone https://github.com/romixlab/qmsgpack.git
|
|
|
|
Now build and install it:
|
|
|
|
.. code-block:: bash
|
|
|
|
cd qmsgpack
|
|
mkdir build && cd build
|
|
cmake ..
|
|
make
|
|
sudo make install
|
|
|
|
There are several useful cmake options available:
|
|
|
|
.. cmdoption:: -DBUILD_TESTS=True
|
|
|
|
Build all the tests, run with ``make tests``
|
|
|
|
.. cmdoption:: -DCMAKE_INSTALL_PREFIX=/usr
|
|
|
|
Change install location to `/usr`
|
|
|
|
.. cmdoption:: -DCMAKE_BUILD_TYPE=Debug
|
|
|
|
Change build type to debug mode (default is `Release`), could be very useful if something goes wrong
|
|
|
|
Add options before ``..`` as follow:
|
|
|
|
.. code-block:: bash
|
|
|
|
cmake -DCMAKE_INSTALL_PREFIX=/usr -DBUILD_TESTS=True ..
|
|
|
|
qmake
|
|
^^^^^
|
|
|
|
Get the latest qmsgpack version by grabbing the source code from GitHub:
|
|
|
|
.. code-block:: bash
|
|
|
|
$ git clone https://github.com/romixlab/qmsgpack.git
|
|
|
|
Now build and install it:
|
|
|
|
.. code-block:: bash
|
|
|
|
cd qmsgpack
|
|
qmake
|
|
make
|
|
sudo make install
|
|
|
|
Also you can just open ``qmsgpack.pro`` in Qt Creator and build it from there.
|
|
|
|
Use it
|
|
======
|
|
|
|
Just add following lines to your .pro file:
|
|
|
|
.. code-block:: makefile
|
|
|
|
LIBS += -lqmsgpack
|
|
|
|
On Windows you may also set the ``INCLUDEPATH`` variable to appropriate location
|