From c553d18a9a7e70b1e08bf5e919243c8c0303890e Mon Sep 17 00:00:00 2001
From: ylecollen <ylecollen@amdocs.com>
Date: Tue, 20 Dec 2016 10:42:06 +0100
Subject: [PATCH] Update the readme files.
---
README.rst | 6 ++++++
java/android/OlmLibSdk/README.rst | 26 ++++++++++++++++++++++++++
2 files changed, 32 insertions(+)
create mode 100644 java/android/OlmLibSdk/README.rst
diff --git a/README.rst b/README.rst
index be1fb1a..3287dbd 100644
--- a/README.rst
+++ b/README.rst
@@ -32,6 +32,12 @@ To build the javascript bindings, install emscripten from http://kripken.github.
.. code:: bash
make js
+
+To build the android project for Android bindings, run:
+
+ .. code:: bash
+ cd java/android/OlmLibSdk/OlmLibSdk
+ ./gradlew clean assembleRelease
Release process
---------------
diff --git a/java/android/OlmLibSdk/README.rst b/java/android/OlmLibSdk/README.rst
new file mode 100644
index 0000000..049eed8
--- /dev/null
+++ b/java/android/OlmLibSdk/README.rst
@@ -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.
\ No newline at end of file
--
GitLab