diff options
author | mathieui <mathieui@mathieui.net> | 2015-10-02 19:15:01 +0200 |
---|---|---|
committer | mathieui <mathieui@mathieui.net> | 2015-10-02 19:22:26 +0200 |
commit | d5188ac68a7a987688d48921ae1b54e2eb4ab595 (patch) | |
tree | c3f720e6de14ebe26496e7e9be15368578e6c987 /README.rst | |
parent | ada9444bf84bd238238c4d22561f69184dd22cdd (diff) | |
download | slixmpp-d5188ac68a7a987688d48921ae1b54e2eb4ab595.tar.gz slixmpp-d5188ac68a7a987688d48921ae1b54e2eb4ab595.tar.bz2 slixmpp-d5188ac68a7a987688d48921ae1b54e2eb4ab595.tar.xz slixmpp-d5188ac68a7a987688d48921ae1b54e2eb4ab595.zip |
Mention the build of cython modules in the README
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 9 |
1 files changed, 9 insertions, 0 deletions
@@ -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``. |