Cool_Tools/bemaniutils
1
0
Fork 0
mirror of synced 2025-02-20 20:50:59 +01:00
Code Releases Activity

Add development tips section, currently containing cython stuff.

Browse Source
This commit is contained in:
Jennifer Taylor 2021-05-19 16:26:39 +00:00
parent 48e9c59513
commit d6e04acde5
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -720,3 +720,23 @@ existing migrations do just that, so have a look at them under
Once the script finishes, check out the created migration script to be sure its correct
and then check it in.
# Development Tips
Several core components of this repo have a parallel C++ implementation for massive
speed boosts. Several components are also cythonized to squeeze a bit more speed out of
them as well. This project aims to provide a pure-python implementation of everything so
it is not necessary to run with cythonized or compiled code either in development or
production. However, if you want to benefit from the massive speed bumps provided by
the equivalent implementations you can compile the code in-place for your development
setup. The following will compile all needed libraries assuming you have a working
C++ compiler and cython is set up to run on your computer:
```
python3 setup.py build_ext --inplace
```
If you are modifying files that have an equivalent C++ implementation and it changes
their semantics, make sure to test both paths! If you are modifying code that is
cythonized and you've compiled, make sure to re-run the above command or delete the
compiled `.so` files, otherwise your changes will not show up when you test.