aboutsummaryrefslogtreecommitdiff
path: root/java/android/OlmLibSdk/README.rst
diff options
context:
space:
mode:
authorylecollen <ylecollen@amdocs.com>2017-01-10 14:45:30 +0100
committerylecollen <ylecollen@amdocs.com>2017-01-10 14:45:30 +0100
commit8ea5bc7960a31ba42abeeae9f0cab4ffb1319987 (patch)
treed113471edd8f66c65f7423ed7ddbf1e93932c12d /java/android/OlmLibSdk/README.rst
parent03ae28e0873486649421b9428c4407851a89241c (diff)
parent4323bec5d6e71fdb38d88ea4f68cf6923092bcc2 (diff)
Merge remote-tracking branch 'origin/pedroc/android_e2e_dev' into pedroc/android_e2e_dev
Diffstat (limited to 'java/android/OlmLibSdk/README.rst')
-rw-r--r--java/android/OlmLibSdk/README.rst31
1 files changed, 17 insertions, 14 deletions
diff --git a/java/android/OlmLibSdk/README.rst b/java/android/OlmLibSdk/README.rst
index 7729506..6a9eae8 100644
--- a/java/android/OlmLibSdk/README.rst
+++ b/java/android/OlmLibSdk/README.rst
@@ -1,26 +1,29 @@
OlmLibSdk
=========
-OlmLibSdk exposes An android wrapper to libolm.
-
+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')
+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.
+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
+The project contains some tests under AndroidTests package.