Updated README.rst for later qi versions #34
Conversation
The Readme file previously contained outdated installation instructions, which have now been updated as follows: - The qi version referenced in the libqi Git clone was 4.0.1. However, the libboost used for the latest version of libqi-python (3.1.5) and libqi (4.0.1) was incompatible. The correct match is with libqi 4.0.3, so the reference has been updated accordingly. - The Conan version was previously set to 2.0, but this version does not support the verbose option used in conanfile.py. The version has been updated to 2.10 to resolve this issue. - The Readme did not clearly differentiate between C++ bindings and Python wheel installation instructions. Since many users, including myself, were building the project for Python, a clarification has been added to distinguish the two.
|
Hello @stavyadatta Thank you for your work on that. I'll review your changes but they look good to me overall. |
| @@ -57,7 +57,7 @@ following way: | |||
| .. code-block:: console | |||
|
|
|||
| # install/upgrade Conan 2 | |||
| pip install --upgrade conan~=2 | |||
| pip install --upgrade conan==2.10 | |||
There was a problem hiding this comment.
The previous version was wrong indeed (~=2 does not seem to work with pip install), but I think I'd prefer suggesting any Conan version above 2.10:
pip install --upgrade conan~=2.10There was a problem hiding this comment.
I will make the update to pull request
| @@ -87,7 +87,7 @@ first get and export the `libqi` recipe into your local Conan cache. | |||
| # versions of libqi require it | |||
| # because of a bug. | |||
|
|
|||
| You can then install the `libqi-python` dependencies in Conan. | |||
| You need to navigate to the ``${HOME}/libqi`` directory and install libqi dependencies. | |||
There was a problem hiding this comment.
It's not exactly correct. The conan install . command below is supposed to be run in the libqi-python directory, and not in libqi. Once the libqi project is exported in Conan (with conan export), the conan install . in libqi-python should build both libqi and its dependencies.
| @@ -110,6 +110,14 @@ calling: | |||
|
|
|||
| cmake --list-presets | |||
|
|
|||
| Navigate back to the ``libqi-python`` directory | |||
There was a problem hiding this comment.
You're completely right. The instructions below are about building libqi-python native code for development or testing purposes, and not building the wheel. So there should be a section on the same level as the "Wheel" once below.
It's not that much about building "C++ bindings", it's just a different process and purpose.
The Readme file previously contained outdated installation instructions, which led to issues during compilation on my Raspberry Pi 5. These have now been updated as follows:
The qi version referenced in the libqi git clone was 4.0.1. However, the libboost used for the latest version of libqi-python (3.1.5) and libqi (4.0.1) was incompatible (1.83 vs 1.78). The correct match is with libqi 4.0.3, so the reference has been updated accordingly.
The Conan version was previously set to 2.0, but this version does not support the verbose option used in conanfile.py. The version has been updated to 2.10 to resolve this issue.
The Readme did not clearly differentiate between C++ bindings and Python wheel installation instructions. Since many users, including myself, were building the project for Python, a clarification has been added to distinguish the two.