aboutsummaryrefslogtreecommitdiff
path: root/java/android/OlmLibSdk/README.rst
diff options
context:
space:
mode:
authorRichard van der Hoff <github@rvanderhoff.org.uk>2017-01-10 11:32:52 +0000
committerGitHub <noreply@github.com>2017-01-10 11:32:52 +0000
commit4323bec5d6e71fdb38d88ea4f68cf6923092bcc2 (patch)
treeb73f65de98c365a18290e31b291b417672462cef /java/android/OlmLibSdk/README.rst
parenteeb210f733924d9c48e82c66e53f0630f05d894e (diff)
README.rst: fix formatting
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.