README.md 2.41 KB
Newer Older
Adrien Béraud's avatar
Adrien Béraud committed
1
Jami for macOS
2
**********
Socapex's avatar
Socapex committed
3

Adrien Béraud's avatar
Adrien Béraud committed
4
This is the official Mac port of Jami.
Socapex's avatar
Socapex committed
5

6
For more information about the ring project, see the following:
Adrien Béraud's avatar
Adrien Béraud committed
7 8 9
- Main website: https://jami.net/
- Bug tracker: https://git.jami.net
- Repositories: https://review.jami.net
10

Romain Bertozzi's avatar
Romain Bertozzi committed
11 12
| App | CI | Packaging
| :-: | :-: | :-:
Adrien Béraud's avatar
Adrien Béraud committed
13
| [![Download from jami.net](https://img.shields.io/badge/download-cx.ring-blue.svg)](https://jami.net/download-jami-macos) | [![Build Status](https://test.savoirfairelinux.com/buildStatus/icon?job=ring-client-macosx)](https://test.savoirfairelinux.com/job/ring-client-macosx/) | [![Build Status](https://test.savoirfairelinux.com/buildStatus/icon?job=ring-packaging-client-macosx)](https://test.savoirfairelinux.com/job/ring-packaging-client-macosx/)
Romain Bertozzi's avatar
Romain Bertozzi committed
14

15 16 17
Requirements
=============

Adrien Béraud's avatar
Adrien Béraud committed
18
- Jami daemon
19 20 21 22 23 24 25
- libRingClient (Qt5 version)
- Qt5 Core
- Cocoa framework

Build instructions
==================

26 27
Build Sparkle framework (optional)
----------------------------------
Adrien Béraud's avatar
Adrien Béraud committed
28
Jami can ship with the Sparkle framework to allow automatic app updates.
29 30
This can be disabled for your custom build by specifying -DENABLE_SPARKLE=false
in the cmake phase.
31

32 33 34 35 36 37 38 39 40 41 42 43 44
1. cd sparkle/
2. git submodule update
3. cd Sparkle/
4. make release
5. A Finder window will popup in the directory where Sparkle has been built.
Copy-paste the Sparkle.framework in sparkle/ in our project, or in
/Library/Frameworks on your system.

Build Client
------------

1. mkdir build && cd build

45
2. export CMAKE_PREFIX_PATH=\<dir_to_qt5\>
46 47

Now generate an Xcode project with CMake:
48
3. cmake ../ -DCMAKE_INSTALL_PREFIX=\<libringclient_install_path\> -G Xcode
49 50
4. open Ring.xcodeproj/
5. Build and run it from Xcode. You can also generate the final Ring.app bundle.
51 52 53

You can also build it from the command line:

54
3. cmake ../ -DCMAKE_INSTALL_PREFIX=\<libringclient_install_path\>
55 56 57 58 59 60 61 62 63
4. make
5. open Ring.app/

If you want to create the final app (self-containing .dmg):

4. make install
5. cpack -G DragNDrop Ring

Notes:
64

65
By default the client version is specified in CMakeLists.txt but it can be
66
overriden by specifying -DRING_VERSION=\<num\> in the cmake command line.
67

68 69 70
You can specify a custom ringtone folder containing audio files (only)
with -DRINGTONE_DIR option

71 72 73 74 75 76 77
Debugging
==================

For now, the build type of the client is "Debug" by default, however it is
useful to also have the debug symbols of libRingClient. To do this, specify this
when compiling libRingClient with '-DCMAKE_BUILD_TYPE=Debug' in the cmake
options.