yetangitu/deltachat
1
0
Fork 0
mirror of https://github.com/deltachat/deltachat-android.git synced 2025-10-03 01:39:18 +02:00
Code Issues Releases Wiki Activity
deltachat/README.md
B. Petersen 817a6c6e6b
update README to rust build instructions
2019-10-02 22:14:55 +02:00

3.7 KiB
Raw Blame History

Delta Chat Android Client

This is the Android client for Delta Chat. It is available on F-Droid and the Google Play Store. The APK can also be downloaded from GitHub (only for experienced users).

For the core library and other common info, please refer to the Delta Chat Core Library.

Screenshot Chat List Screenshot Chat View

Build

When checking out deltachat-android, make sure also to check out the subproject deltachat-core-rust:

  • When using Git, you can do this initially by $ git clone --recursive https://github.com/deltachat/deltachat-android or later by git submodule update --init --recursive. If you do this in your home directory, this results in the folder ~/deltachat-android which is just fine.

Then, open ndk-make.sh in an editor and follow the instructions to set up a rust build environment. This is needed only once.

After that, call ./ndk-make.sh in the root directory to build core-rust. Afterwards run the project in Android Studio. The project requires API 25.

With chance, that's it :) - if not, read on how to set up a proper development environment.

Install Development Environment

  1. Some libs required by Android Studio may be missing on 64 bit Linux machines [Source], so for Ubuntu execute $ sudo apt-get install libc6:i386 libncurses5:i386 libstdc++6:i386 lib32z1 libbz2-1.0:i386 and for Fedora execute $ sudo yum install zlib.i686 ncurses-libs.i686 bzip2-libs.i686.

  2. Download Android Studio from https://developer.android.com (android-studio-ide-...-linux.zip) and unpack the archive which contains a single folder called android-studio; move this folder e.g. to ~/android-studio.

  3. To launch Android Studio for the first time, open a terminal, navigate to ~/android-studio/bin, execute ./studio.sh and use all the standard values from the wizard.

  4. Android Studio now asks you if you want to download an existing project; choose ~/deltachat-android as created in the "Build" chapter (Android Studio starts to build the project, however, there are some steps missing before this will succeed).

  5. As Delta Chat uses API 25 for some reasons, click on the corresponding error message and install "Nougat 7.1.1 (API 25)" and the "Build-Tools" (you should also find the option at "Tools / Android / SDK Manager / SDK Platforms"). Now the build should succeed - but the app still misses the native part.

  6. Agree to the terms and download Android NDK Revision 14b from NDK Archives (Newer releases shall not be used currently, they are not compatible, see issues #197, #220, #248) and extract the archive containing a single folder called android-ndk-r…; move this folder e.g. to ~/android-ndk-r….

  7. Export the folder path to your environment as ANDROID_NDK and add it to PATH. You can archive this e.g. by adding the following lines to .bashrc export ANDROID_NDK=/home/bpetersen/android-ndk-r… export PATH=$PATH:$ANDROID_NDK.

The last two steps may be omitted by using the new Android Studio NDK options, however, thus far, we have not found the time to do so.

Credits

The user interface classes are based on the Signal messenger.

License

Licensed GPLv3+, see the LICENSE file for details.

Copyright © 2017-2019 Delta Chat contributors.