diff --git a/README.md b/README.md index fd527f7ca53d8786228c0185eadadde4cafa987f..ddfc582f488eec416cc37caf2248b1134d712c20 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Jami Android -This repository is meant for the porting of Jami to Android. +The Jami client for Android | App | CI | :-: | :-: | @@ -8,80 +8,30 @@ This repository is meant for the porting of Jami to Android. ## Environment -Clone this as a submodule of: -<https://review.jami.net/#/admin/projects/ring-project> -to obtain the required Jami daemon source. - -You can also manually clone the daemon and override the DAEMON_DIR -during compilation - -Make sure you have the android-ndk and android-sdk, and you'll want something -like this in your .bashrc (or equivalent): - - export ANDROID_NDK=$HOME/src/android-ndk - export ANDROID_NDK_ROOT=$ANDROID_NDK - export ANDROID_SDK=$HOME/src/android-sdk-linux - export ANDROID_HOME=$ANDROID_SDK - export PATH=$ANDROID_SDK/platform-tools:${PATH} - -install swig-4.0.0 or later and python-3.7 or later on your system +Install autotools, autopoint, swig-4 or later and python-3.7 or later on your system ## Build instructions -Supported archs are: armeabi-v7a , arm64-v8a and x86_64 - -Example: - - ANDROID_ABI="arm64-v8a x86_64" - -Then: - - ./compile.sh - -If you cloned the daemon in a custom directory (other than ../daemon), -you can specify it using an **absolute path**: +With Android Studio: +* Add 'ring-project' in Android Studio +* Click on build +* Enjoy! - DAEMON_DIR=custom_path ./compile.sh - -**When all else fails**: - - git clean -dfx - cd ../daemon (or custom_path) - git clean -dfx - -And start again. +With the command line: +* cd client-android/ring-project +* ./gradlew assembleDebug ## Update translations Update translations using the Transifex client (tx) : - ./update-translations.sh -## Debugging - -Retrieve client log from device (client must be running before executing this) - -```sh -jami_pid=$(adb shell ps | egrep 'cx.ring' | cut -c10-15) \ - && test -n "$jami_pid" || (echo "failed to retrieve jami pid" && exit 1) \ - && adb logcat '*:D' | grep "$jami_pid" | tee jami.log -``` - -## Common issues - -* Makeinfo issue - makeinfo: command not found - WARNING: 'makeinfo' is missing on your system. - **Solution**: Install texinfo package containing makeinfo dep. +# Generate new release commit -* Unable to locate tools.jar - **Solution**: Your java installation is not pointing to a JDK. - Install one, or make JAVA_HOME point to it. +Generate a new release commit updating the version code and version string: + ./update_version.py --commit -* When building the apk error in build-tools - error while loading shared libraries: libstdc++.so.6 - **Solution**: Install lib32stdc++6 lib32z1-dev +# Report issues -* When compiling on Fedora - error while loading shared libraries: libtinfo.so.5: cannot open shared object file: No such file or directory - **Solution***: sudo dnf install ncurses-compat-libs +Report issues on Gitlab: +https://git.jami.net/savoirfairelinux/jami-client-android