jshiffer/slixmpp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Mention the build of cython modules in the README

Browse Source
This commit is contained in:
mathieui 2015-10-02 19:15:01 +02:00
parent ada9444bf8
commit d5188ac68a
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.rst
View File

@ -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 socket handling, the timers, the events dispatching) in order to remove all
threads. 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 and Testing
------------------------- -------------------------
Documentation can be found both inline in the code, and as a Sphinx project in ``/docs``. Documentation can be found both inline in the code, and as a Sphinx project in ``/docs``.