Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update installation instructions to mention conda and force users to use venv on apt #45

Merged
merged 2 commits into from
Oct 31, 2024
Merged

Update installation instructions to mention conda and force users to use venv on apt #45

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
277934d
Update installation instructions to mention conda and force users to …
traversaro Oct 28, 2024
d12aa4b
Add console decorator to code block
traversaro Oct 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 14 additions & 11 deletions README.md
View file
Open in desktop
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is python3-pip required?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After we created the venv, we install the python package with pip install, so it is required there (unless I am missing something in the question).

```

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`:

~~~
traversaro marked this conversation as resolved.
Show resolved Hide resolved
conda create -n urdfmodifiersenv urdf-modifiers
conda activate urdfmodifiersenv
~~~

## :rocket: Usage

### Link and Joint Modifier
Expand Down