diff options
author | Richard van der Hoff <richard@matrix.org> | 2016-05-13 11:36:41 +0100 |
---|---|---|
committer | Richard van der Hoff <richard@matrix.org> | 2016-05-20 15:15:40 +0100 |
commit | b3a7a6b36c695abc5515e806464b497997f59115 (patch) | |
tree | 3524479694ca97a52839ebbd56e89ebccca846f9 /README.rst | |
parent | acae4e84386056e80eb4bb633fcdf03375c087ea (diff) |
Add a makefile
Replace the python scripts for building the shared lib and tests with a
Makefile, which makes it easier to handle a mix of C and C++.
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 14 |
1 files changed, 9 insertions, 5 deletions
@@ -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 |