diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 20 |
1 files changed, 12 insertions, 8 deletions
@@ -5,12 +5,10 @@ An implementation of the Double Ratchet cryptographic ratchet described by https://github.com/trevp/double_ratchet/wiki, written in C and C++11 and exposed as a C API. -The specification of the Olm ratchet can be found in ``docs/olm.rst`` or -https://matrix.org/docs/spec/olm.html. +The specification of the Olm ratchet can be found in `<docs/olm.rst>`_. This library also includes an implementation of the Megolm cryptographic -ratchet, as specified in ``docs/megolm.rst`` or -https://matrix.org/docs/spec/megolm.html. +ratchet, as specified in `<docs/megolm.rst>`_. Building -------- @@ -32,12 +30,13 @@ 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 android - ./gradlew clean assembleRelease +.. code:: bash + + cd android + ./gradlew clean assembleRelease To build the Xcode workspace for Objective-C bindings, run: @@ -60,6 +59,7 @@ It's probably sensible to do the above on a release branch (``release-vx.y.z`` by convention), and merge back to master once the release is complete. .. code:: bash + make clean # build and test C library @@ -129,6 +129,10 @@ Olm uses pure C implementations of the cryptographic primitives used by the ratchet. While this decreases the performance it makes it much easier to compile the library for different architectures. +Contributing +------------ +Please see `<CONTRIBUTING.rst>`_ when making contributions to the library. + What's an olm? -------------- |