Stepan Salenikovich | e3500cb | 2015-02-13 15:55:46 -0500 | [diff] [blame] | 1 | ring-client-gnome |
| 2 | ***************** |
| 3 | |
| 4 | Ring-client-gnome is a Ring client written in GTK+3. It uses libRingClient to |
| 5 | communicate with the Ring daemon and for all of the underlying models and their |
| 6 | logic. Ideally ring-client-gnome should only contain UI related code and any |
| 7 | wrappers necessary for interacting with libRingClient. |
| 8 | |
Stepan Salenikovich | 4e740b6 | 2015-03-13 14:06:49 -0400 | [diff] [blame] | 9 | |
Stepan Salenikovich | e3500cb | 2015-02-13 15:55:46 -0500 | [diff] [blame] | 10 | Requirements |
| 11 | ================== |
| 12 | |
| 13 | - Ring daemon |
| 14 | - libRingClient (Qt5 version) |
| 15 | - GTK+3 (3.10 or higher) |
| 16 | - Qt5 Core |
| 17 | |
Stepan Salenikovich | 4e740b6 | 2015-03-13 14:06:49 -0400 | [diff] [blame] | 18 | |
Stepan Salenikovich | e3500cb | 2015-02-13 15:55:46 -0500 | [diff] [blame] | 19 | Compiling |
| 20 | ================== |
| 21 | |
| 22 | In the project root dir: |
| 23 | mkdir build |
| 24 | cd build |
| 25 | cmake .. |
| 26 | make |
| 27 | |
| 28 | Then simply run ./ring-client-gnome |
Stepan Salenikovich | 4e740b6 | 2015-03-13 14:06:49 -0400 | [diff] [blame] | 29 | |
| 30 | |
| 31 | Building without installing Ring daemon and libRingClient |
| 32 | ================== |
| 33 | |
| 34 | It is possible to build ring-client-gnome without installing the deamon and |
| 35 | libRingClient on your system (eg: in /usr or /usr/local): |
| 36 | |
| 37 | 1. build the daemon |
| 38 | 2. when building libRingClient, specify the location of the daemon lib in the |
| 39 | cmake options with -DRING_BUILD_DIR=, eg: |
| 40 | -DRING_BUILD_DIR=/home/user/ring/daemon/src |
| 41 | 3. to get the proper headers, we still need to 'make install' libRingClient, but |
| 42 | we don't have to install it in /usr, so just specify another location for the |
| 43 | install prefix in the cmake options, eg: |
| 44 | -DCMAKE_INSTALL_PREFIX=/home/user/ringinstall |
| 45 | 4. now compile libRingClient and do 'make install', everything will be installed |
| 46 | in the dir specified by the prefix |
| 47 | 4. now we just have to give the same install prefix to the cmake options of the |
| 48 | client and it will find libRingClient: |
| 49 | -DCMAKE_INSTALL_PREFIX=/home/user/ringinstall |
| 50 | |
| 51 | |
| 52 | Debugging |
| 53 | ================== |
| 54 | |
| 55 | For now, the build type of the client is "Debug" by default, however it is |
| 56 | useful to also have the debug symbols of libRingClient. To do this, specify this |
| 57 | when compiling libRingClient with '-DCMAKE_BUILD_TYPE=Debug' in the cmake |
| 58 | options. |