From b3a7a6b36c695abc5515e806464b497997f59115 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Fri, 13 May 2016 11:36:41 +0100 Subject: 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++. --- README.rst | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) (limited to 'README.rst') 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 -- cgit v1.2.3 From d4c8aae803a1fad46ded6e82a64575d9b6e40a7e Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Fri, 20 May 2016 09:36:50 +0100 Subject: Add support for building the JS wrappers to the Makefile Now that we have C and C++, we need to split the compile and link steps (because we need different flags for the C and C++ files), so this is easier with a Makefile. --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 0075d84..0f3ae4f 100644 --- a/README.rst +++ b/README.rst @@ -26,7 +26,7 @@ To build the javascript bindings, install emscripten from http://kripken.github. .. code:: bash - javascript/build.py # builds javascript/olm.js + make js npm pack javascript # packages olm.js into olm-x.y.z.tgz Remember to make a tag after releasing a tarball: -- cgit v1.2.3