Update Build instructions

This commit is contained in:
Mohamed Fenjiro
2019-01-28 14:58:14 -05:00
parent 3903ed000f
commit cb62c6ca69

View File

@ -1,11 +1,11 @@
**Ring relies on various components which interact together.**
**Jami relies on various components which interact together.**
![Ring-layers](/uploads/ccc91eff2ab16cb68c6c51dd6fad0f63/Ring-layers.png)
They are divided into three main layers:
1\. **LibRing** (or Daemon) is the core of
Ring. It does not interact with users but it is involved in every
1\. **Daemon** is the core of
Jami. It does not interact with users but it is involved in every
command.
2\. **LibRingClient** (or LRC) is written in
@ -16,11 +16,11 @@ It does not interact with the Android client.
use-case on GNU/Linux (Gnome), Windows, Mac OS X and Android.
To fully build Ring, you must build each of these components in order,
unless you choose to build Ring easily and quickly.
To fully build Jami, you must build each of these components in order,
unless you choose to build Jami easily and quickly.
How to Build Ring Easily and Quickly
How to Build Jami Easily and Quickly
===============================================================
We use a GIT repository to manage sources. On shell based platform you
@ -30,7 +30,7 @@ can fetch your private copy using following command:
git clone https://gerrit-ring.savoirfairelinux.com/ring-project
```
Ring installer uses **python3**. If it's not installed, please install
Jami installer uses **python3**. If it's not installed, please install
it:
```bash
@ -460,7 +460,7 @@ here:
<https://gerrit-ring.savoirfairelinux.com>
This service works for all Ring sub-projects (LibRing, LRC and clients).
This service works for all Jami sub-projects (LibRing, LRC and clients).
How to Build LibRingClient (or LRC)
==============================================================
@ -566,7 +566,7 @@ ready to use clients for major platforms.
Choose your client build instructions below
Gnome Client for Ring
Gnome Client for Jami
------------------------------------------------
+ LibRing and LibRingClient
@ -621,7 +621,7 @@ via 'make doc'
- GTK+ &gt;= 3.10
- clutter and clutter-gtk
- the Ring daemon and libRingClient
- the Jami daemon and libRingClient
- Qt5Core (libRingClient uses the Core module of Qt5, thus Qt5Core is
required to properly interface between it and GTK)
- gnome-icon-theme-symbolic, for the use of certain symbolic icons
@ -689,13 +689,13 @@ LibRingClient it is located. Finally, you build client-gnome.
5. Build client-gnome by running "make".
To run an install-less Ring, you must manually start the daemon and then
To run an install-less Jami, you must manually start the daemon and then
the client, e.g.:
term1: $HOME/ring-project/daemon/bin/dring -cdp
term2: $HOME/ring-project/client-gnome/gnome-ring --debug
KDE Client for Ring
KDE Client for Jami
----------------------------------------------
![](Caution.png "fig:Caution.png"){width="30"} LibRing and LibRingClient
@ -739,7 +739,7 @@ If LibRing isn't installed, you can use:
`-DRING_BUILD_DIR=$RING`
Windows Client for Ring
Windows Client for Jami
--------------------------------------------------
+ LibRing and LibRingClient
@ -819,7 +819,7 @@ cd build/release
makensis ring.nsi
```
Mac OS X Client for Ring
Mac OS X Client for Jami
---------------------------------------------------
+ LibRing and LibRingClient
@ -894,7 +894,7 @@ make install -j
cpack -G DragNDrop Ring
```
iOS Client for Ring
iOS Client for Jami
----------------------------------------------
After installing [Brew](https://brew.sh) and Python3 (brew install