| 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 | 137376c | 2015-04-15 14:25:43 -0400 | [diff] [blame] | 9 | Packages for Debian/Ubuntu/Fedora can be found on http://ring.cx |
| 10 | |
| 11 | More info about the Ring project or this client can be found on their respective wiki pages: |
| 12 | - https://projects.savoirfairelinux.com/projects/ring/wiki |
| 13 | - https://projects.savoirfairelinux.com/projects/ring-gnome-client/wiki |
| 14 | |
| Stepan Salenikovich | 4e740b6 | 2015-03-13 14:06:49 -0400 | [diff] [blame] | 15 | |
| Stepan Salenikovich | e3500cb | 2015-02-13 15:55:46 -0500 | [diff] [blame] | 16 | Requirements |
| 17 | ================== |
| 18 | |
| 19 | - Ring daemon |
| Stepan Salenikovich | 137376c | 2015-04-15 14:25:43 -0400 | [diff] [blame] | 20 | - libRingClient |
| Stepan Salenikovich | e3500cb | 2015-02-13 15:55:46 -0500 | [diff] [blame] | 21 | - GTK+3 (3.10 or higher) |
| 22 | - Qt5 Core |
| Stepan Salenikovich | 137376c | 2015-04-15 14:25:43 -0400 | [diff] [blame] | 23 | - X11 |
| 24 | - gnome-icon-theme-symbolic (certain icons are used which other themes might be missing) |
| 25 | - libebook1.2 / evolution-data-server (3.10 or higher) |
| Stepan Salenikovich | 19a251e | 2015-06-10 15:01:37 -0400 | [diff] [blame] | 26 | - libnotify (optional, if you wish to receive desktop notifications of incoming calls, etc) |
| Stepan Salenikovich | 137376c | 2015-04-15 14:25:43 -0400 | [diff] [blame] | 27 | |
| 28 | On Debian/Ubuntu these can be installed by: |
| Stepan Salenikovich | 19a251e | 2015-06-10 15:01:37 -0400 | [diff] [blame] | 29 | sudo apt-get install g++ cmake libgtk-3-dev qtbase5-dev libclutter-gtk-1.0-dev gnome-icon-theme-symbolic libebook1.2-dev libnotify-dev |
| Stepan Salenikovich | 137376c | 2015-04-15 14:25:43 -0400 | [diff] [blame] | 30 | |
| 31 | On Fedora: |
| Stepan Salenikovich | 19a251e | 2015-06-10 15:01:37 -0400 | [diff] [blame] | 32 | yum install gcc-c++ cmake gtk3-devel qt5-qtbase-devel clutter-gtk-devel gnome-icon-theme-symbolic evolution-data-server-devel libnotify-devel |
| Stepan Salenikovich | 137376c | 2015-04-15 14:25:43 -0400 | [diff] [blame] | 33 | |
| 34 | The build instruction for the daemon and libRingClient can be found on their respective wiki pages: |
| 35 | - https://projects.savoirfairelinux.com/projects/ring-daemon/wiki |
| 36 | - https://projects.savoirfairelinux.com/projects/libringclient/wiki/Wiki |
| Stepan Salenikovich | e3500cb | 2015-02-13 15:55:46 -0500 | [diff] [blame] | 37 | |
| Stepan Salenikovich | 4e740b6 | 2015-03-13 14:06:49 -0400 | [diff] [blame] | 38 | |
| Stepan Salenikovich | e3500cb | 2015-02-13 15:55:46 -0500 | [diff] [blame] | 39 | Compiling |
| 40 | ================== |
| 41 | |
| 42 | In the project root dir: |
| Stepan Salenikovich | 137376c | 2015-04-15 14:25:43 -0400 | [diff] [blame] | 43 | mkdir build |
| 44 | cd build |
| 45 | cmake .. |
| 46 | make |
| Stepan Salenikovich | e3500cb | 2015-02-13 15:55:46 -0500 | [diff] [blame] | 47 | |
| Stepan Salenikovich | 19a251e | 2015-06-10 15:01:37 -0400 | [diff] [blame] | 48 | You can then simply run ./gnome-ring from the build directory |
| 49 | |
| 50 | Installing |
| 51 | ================== |
| 52 | |
| 53 | If you're building the client for use (rather than testing of packaging), it is |
| 54 | recommended that you install it on your system, eg: in '/usr', '/usr/local', or |
| 55 | '/opt', depending on your distro's preference to get full functionality such as |
| 56 | desktop integration. In this case you should perform a 'make install' after |
| 57 | building the client. |
| Stepan Salenikovich | 4e740b6 | 2015-03-13 14:06:49 -0400 | [diff] [blame] | 58 | |
| 59 | |
| 60 | Building without installing Ring daemon and libRingClient |
| 61 | ================== |
| 62 | |
| 63 | It is possible to build ring-client-gnome without installing the deamon and |
| 64 | libRingClient on your system (eg: in /usr or /usr/local): |
| 65 | |
| 66 | 1. build the daemon |
| 67 | 2. when building libRingClient, specify the location of the daemon lib in the |
| 68 | cmake options with -DRING_BUILD_DIR=, eg: |
| 69 | -DRING_BUILD_DIR=/home/user/ring/daemon/src |
| 70 | 3. to get the proper headers, we still need to 'make install' libRingClient, but |
| 71 | we don't have to install it in /usr, so just specify another location for the |
| 72 | install prefix in the cmake options, eg: |
| 73 | -DCMAKE_INSTALL_PREFIX=/home/user/ringinstall |
| 74 | 4. now compile libRingClient and do 'make install', everything will be installed |
| 75 | in the dir specified by the prefix |
| 76 | 4. now we just have to give the same install prefix to the cmake options of the |
| 77 | client and it will find libRingClient: |
| 78 | -DCMAKE_INSTALL_PREFIX=/home/user/ringinstall |
| 79 | |
| 80 | |
| 81 | Debugging |
| 82 | ================== |
| 83 | |
| 84 | For now, the build type of the client is "Debug" by default, however it is |
| 85 | useful to also have the debug symbols of libRingClient. To do this, specify this |
| 86 | when compiling libRingClient with '-DCMAKE_BUILD_TYPE=Debug' in the cmake |
| Stepan Salenikovich | 137376c | 2015-04-15 14:25:43 -0400 | [diff] [blame] | 87 | options. |