From d5188ac68a7a987688d48921ae1b54e2eb4ab595 Mon Sep 17 00:00:00 2001 From: mathieui Date: Fri, 2 Oct 2015 19:15:01 +0200 Subject: [PATCH] Mention the build of cython modules in the README --- README.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.rst b/README.rst index 55edbc4b..dd8f59e4 100644 --- a/README.rst +++ b/README.rst @@ -8,6 +8,15 @@ Slixmpp's goals is to only rewrite the core of the library (the low level socket handling, the timers, the events dispatching) in order to remove all threads. +Building +-------- + +Slixmpp can make use of cython to improve performance on critical modules. +To do that, cython3 is necessary along with libidn headers. Otherwise, +no compilation is needed. Building is done by running setup.py:: + + python3 setup.py build_ext --inplace + Documentation and Testing ------------------------- Documentation can be found both inline in the code, and as a Sphinx project in ``/docs``.