Skip to content
Snippets Groups Projects
Commit 388b9429 authored by Pierre Nicolas's avatar Pierre Nicolas :joy:
Browse files

docs: update readme

Swig needs to be at least version 4.2.
GitLab: #1705

Change-Id: I8f8fd8532b299cfdcc90e4573d1fde2052d694c7
parent ffb9ec35
No related branches found
No related tags found
No related merge requests found
...@@ -8,25 +8,55 @@ The Jami client for Android ...@@ -8,25 +8,55 @@ The Jami client for Android
## Environment ## Environment
### Submodule
Download the project including the daemon submodule with: Download the project including the daemon submodule with:
> git clone --recursive https://review.jami.net/jami-client-android
```sh
git clone --recursive https://review.jami.net/jami-client-android
```
Or to download the daemon submodule from the existing project directory: Or to download the daemon submodule from the existing project directory:
> git submodule update --init --recursive
Make sure to have autotools, autopoint, swig, yasm, m4, ninja-build and cmake available on your system: ```sh
on Debian/Ubuntu: git submodule update --init --recursive
> apt install cmake build-essential swig yasm ninja-build m4 autotools-dev autopoint ```
### Dependencies
On Arch: Make sure to have autotools, autopoint, swig, yasm, m4, ninja-build and cmake available on your system.
> pacman -S cmake ninja automake swig yasm m4 patch autoconf pkgconf
On macOS: > [!WARNING]
> brew install cmake automake autotools libtool pkg-config yasm swig >
> Jami needs at least swig 4.2 to work. Else it will raise errors at compilation.
> See if the package is available with this version from your package manager, else you will need to install it [from sources](https://github.com/swig/swig).
##### On Debian/Ubuntu
```sh
apt install cmake build-essential swig yasm ninja-build m4 autotools-dev autopoint
```
##### On Arch
```sh
pacman -S cmake ninja automake swig yasm m4 patch autoconf pkgconf
```
##### On macOS:
```sh
brew install cmake automake autotools libtool pkg-config yasm swig
```
When using brew on macOS, the 'libtoolize' binary might be available as 'glibtoolize'. When using brew on macOS, the 'libtoolize' binary might be available as 'glibtoolize'.
In that case, the following command makes it avaialble to the build system: In that case, the following command makes it avaialble to the build system:
> ln -s /opt/homebrew/bin/glibtoolize /opt/homebrew/bin/libtoolize
```sh
ln -s /opt/homebrew/bin/glibtoolize /opt/homebrew/bin/libtoolize
```
### Android SDK & NDK
Make sure to have the Android SDK and NDK available. Make sure to have the Android SDK and NDK available.
...@@ -46,12 +76,16 @@ cd jami-client-android/jami-android ...@@ -46,12 +76,16 @@ cd jami-client-android/jami-android
## Update translations ## Update translations
Update translations using the Transifex client (tx) : Update translations using the Transifex client (tx) :
> ./update-translations.sh ```sh
./update-translations.sh
```
# Generate new release commit # Generate new release commit
Generate a new release commit updating the version code and version string: Generate a new release commit updating the version code and version string:
> ./update_version.py --commit ```sh
./update_version.py --commit
```
# Report issues # Report issues
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment