From 277934df51af72efc00be92e0a834874e3bbe396 Mon Sep 17 00:00:00 2001 From: Silvio Traversaro Date: Mon, 28 Oct 2024 10:02:09 +0100 Subject: [PATCH] Update installation instructions to mention conda and force users to use venv on apt --- README.md | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 9d1ac2f..522de35 100644 --- a/README.md +++ b/README.md @@ -33,28 +33,31 @@ They will be installed in the installation step! ## :floppy_disk: Installation -Install `python3`, if not installed (in **Ubuntu 20.04**): +### Installation on Ubuntu with `apt` -```bash -sudo apt install python3.8 -``` - - Install the library via pip: +Install `python` and required tools, if not installed: ```bash - -pip install urdf-modifiers - +sudo apt install python3 python3-venv python3-pip ``` -preferably in a [virtual environment](https://docs.python.org/3/library/venv.html#venv-def). For example: + Install the library in a [virtual environment](https://docs.python.org/3/library/venv.html#venv-def), to avoid interfering with the global system: ```bash -pip install virtualenv python3 -m venv your_virtual_env source your_virtual_env/bin/activate +pip install urdf-modifiers ``` +### Installation on Linux/macOS/Windows with `conda` + +Create an environment with `urdf-modifiers`: + +~~~ +conda create -n urdfmodifiersenv urdf-modifiers +conda activate urdfmodifiersenv +~~~ + ## :rocket: Usage ### Link and Joint Modifier