Repo created

libs/search/pysearch/README.txt

@@ -0,0 +1,46 @@
+This document describes how to use this module.
+
+1. How to build?
+
+   To build the module you need Python3.7 (or higher) and Boost Python. Also, you
+   need Qt5.5 (or higher), but you need it in any case if you're
+   planning to build the project. On MacOS, Python3.7 should be
+   installed by default, to get Boost via Brew just type in the shell:
+
+     brew update
+     brew install boost-python3
+
+   On Debian, type in the shell:
+
+     sudo apt-get install libboost-*
+
+   Note that on MacOS Boost is built by default with libc++, on Debian
+   Boost is built by default with libstdc++. Therefore, you can use
+   only macx-clang and linux-clang specs correspondingly. It's wrong
+   to use linux-clang-libc++ because it's generally a bad idea to have
+   two implementations of the C++ standard library in the same
+   application.
+
+   Then, invoke cmake from the shell, for example:
+
+     cmake <path-to-omim-directory>\
+        -DPYBINDINGS=ON\
+        -DPYBINDINGS_VERSION=3.7\
+        -DPYTHON_INCLUDE_DIRS=<path-to-dir-with-Python.h>\
+        -DCMAKE_PREFIX_PATH=<path-to-qt5.5>
+
+     make -k -j8 pysearch
+
+   To set the python paths correctly, refer to https://cmake.org/cmake/help/v3.0/module/FindPythonLibs.html
+   and
+
+     python-config --includes
+
+2. How to use?
+
+   As pysearch is a custom Python module, all that you need
+   is to customize PYTHONPATH environment variable before running your
+   scripts. For example:
+
+     PYTHONPATH=path-to-the-directory-with-pysearch.so \
+       ./search/pysearch/run_search_engine.py