Skip to content

Commit

Permalink
Update installation instructions to mention conda and force users to …
Browse files Browse the repository at this point in the history
…use venv on apt
  • Loading branch information
traversaro authored Oct 28, 2024
1 parent b9adfd1 commit 277934d
Showing 1 changed file with 14 additions and 11 deletions.
25 changes: 14 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 277934d

Please sign in to comment.