aboutsummaryrefslogtreecommitdiff
path: root/android/README.rst
diff options
context:
space:
mode:
authorYannick LE COLLEN <yannick@matrix.org>2017-01-10 16:09:18 +0100
committerGitHub <noreply@github.com>2017-01-10 16:09:18 +0100
commit14c30da0e2bdff675c8af97e3c6ee49fba82af8d (patch)
treed1cc8cbe276b36bd80e9933f2c9c5532ae3a448f /android/README.rst
parentbd6ab72ca40e0484be2a39734ba135437e820d63 (diff)
parentccbb9606b725b8f1d7eeccf14c358b146aeee491 (diff)
Merge pull request #43 from matrix-org/pedroc/android_e2e_dev
Android wrappers for olm library
Diffstat (limited to 'android/README.rst')
-rw-r--r--android/README.rst29
1 files changed, 29 insertions, 0 deletions
diff --git a/android/README.rst b/android/README.rst
new file mode 100644
index 0000000..46beaab
--- /dev/null
+++ b/android/README.rst
@@ -0,0 +1,29 @@
+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 ``android/`` path.
+
+The project contains some JNI files and some Java wraper files.
+
+The project contains some tests under AndroidTests package.