Update the readme files.

This commit is contained in:
ylecollen 2016-12-20 10:42:06 +01:00
parent 2fab6f946e
commit c553d18a9a
2 changed files with 32 additions and 0 deletions

View file

@ -33,6 +33,12 @@ To build the javascript bindings, install emscripten from http://kripken.github.
make js
To build the android project for Android bindings, run:
.. code:: bash
cd java/android/OlmLibSdk/OlmLibSdk
./gradlew clean assembleRelease
Release process
---------------

View file

@ -0,0 +1,26 @@
OlmLibSdk
=========
OlmLibSdk exposes An android wrapper to libolm.
Installation
------------
Create a libs directory in your project directory
Copy the olm-sdk.aar into it.
In your build.gradle file, add in the android section
repositories {
flatDir {
dir 'libs'
}
}
Add in the dependencies category
compile(name: 'olm-sdk', ext: 'aar')
Development
-----------
import the project from the /java/android/OlmLibSdk path.
The project contains some JNI files and some Java wraper files.
The project contains some tests under AndroidTests package.