Skip to main content

Environment Setup

This chapter covers local environment setup for LibXR, CodeGenerator, and XRobot.

Supported Platforms​

LibXR itself is a C++ library that does not depend on a specific operating system. It requires C++17 and the standard C++ library, and can run on bare metal or with an RTOS.

CodeGenerator and XRobot are Python-based packages and require Python 3 plus a working pip3 environment.

Installation​

LibXR​

Clone the repository directly:

git clone https://github.com/Jiu-xiao/libxr.git

For integration into an existing project, submodule or subtree is more common:

git submodule add https://github.com/Jiu-xiao/libxr.git libxr

CodeGenerator (libxr) and XRobot​

Install with pip:

pip install libxr xrobot

Install with pipx:

### Windows
python -m pip install --user pipx
python -m pipx ensurepath
pipx install libxr xrobot
pipx ensurepath
# Restart your terminal

### Linux
sudo apt install pipx
pipx install libxr xrobot
pipx ensurepath
# Restart your terminal

Do not install the same package with both pip and pipx at the same time. That usually leads to mixed PATH state and version conflicts.