aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst14
1 files changed, 9 insertions, 5 deletions
diff --git a/README.rst b/README.rst
index b2f48da..0075d84 100644
--- a/README.rst
+++ b/README.rst
@@ -14,14 +14,13 @@ To build olm as a shared library run:
.. code:: bash
- ./build_shared_library.py
+ make
To run the tests run:
.. code:: bash
- ./test.py
-
+ make test
To build the javascript bindings, install emscripten from http://kripken.github.io/emscripten-site/ and then run:
@@ -43,6 +42,11 @@ Design
Olm is designed to be easy port to different platforms and to be easy
to write bindings for.
+It was originally implemented in C++, with a plain-C layer providing the public
+API. As development has progressed, it has become clear that C++ gives little
+advantage, and new functionality is being added in C, with C++ parts being
+rewritten as the need ariases.
+
Error Handling
~~~~~~~~~~~~~~
@@ -78,13 +82,13 @@ the ratchet. While this decreases the performance it makes it much easier
to compile the library for different architectures.
What's an olm?
-~~~~~~~~~~~~~~
+--------------
It's a really cool species of European troglodytic salamander.
http://www.postojnska-jama.eu/en/come-and-visit-us/vivarium-proteus/
Legal Notice
-~~~~~~~~~~~~
+------------
The software may be subject to the U.S. export control laws and regulations
and by downloading the software the user certifies that he/she/it is