From 99c3777ad61d20396c6908a6272ba111b22164dd Mon Sep 17 00:00:00 2001 From: Stavya Datta <62042596+stavyadatta@users.noreply.github.com> Date: Sat, 8 Feb 2025 17:46:36 +1100 Subject: [PATCH] Updated README.rst for later qi versions 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. --- README.rst | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 8d35691..813bba7 100644 --- a/README.rst +++ b/README.rst @@ -57,7 +57,7 @@ following way: .. code-block:: console # install/upgrade Conan 2 - pip install --upgrade conan~=2 + pip install --upgrade conan==2.10 # create a default profile conan profile detect @@ -75,7 +75,7 @@ first get and export the `libqi` recipe into your local Conan cache. # GitHub is available, but you can also use internal GitLab. QI_REPOSITORY="https://github.com/aldebaran/libqi.git" - QI_VERSION="4.0.1" # Checkout the version your project need. + QI_VERSION="4.0.3" # Checkout the version your project need. QI_PATH="$HOME/libqi" # Or whatever path you want. git clone \ --depth=1 `# Only fetch one commit.` \ @@ -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. .. code-block:: console @@ -110,6 +110,14 @@ calling: cmake --list-presets +Navigate back to the ``libqi-python`` directory + +Now from here you have two options, either to develop the project with only **C++** bindings or +as a **wheel** to run with python + +C++ Bindings +------------ + Here, we'll assume that the preset is named `conan-linux-x86_64-gcc-debug`. To start building, you need to configure with CMake and then build: