Skip to content

Commit 0ca02fd

Browse files
authored
Document installation from conda-forge (#52)
* Document installation from conda-forge * Add links
1 parent 93e8993 commit 0ca02fd

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,29 @@ See the relative documentation for the terms of the license.
3232
How to use Intel RealSense cameras as a YARP device
3333
---------------------------------------------------
3434

35+
First of all, please install the `yarp-device-realsense2` following one (and just one) method listed below, and the move to the `Usage` section.
36+
37+
## Install with conda or pixi (easy)
38+
39+
You can easily the library with [`conda`](https://docs.conda.io/en/latest/) in a new conda environment with
40+
```
41+
conda create -n newenvname -c conda-forge yarp-device-realsense2
42+
```
43+
44+
`conda` will automatically install all the supported dependencies.
45+
46+
To add yarp-device-realsense2 to a [`pixi`](https://pixi.sh/latest/) project, just run:
47+
48+
```
49+
pixi add yarp-device-realsense2
50+
```
51+
52+
## Installation from source (advanced)
53+
54+
If you want to use a package manager (for example `apt` on Ubuntu) that does not provide `yarp-device-realsense2` packages, you can do that
55+
as `yarp-device-realsense2` is a fairly standard CMake project. To do that, first of all install either via a package
56+
manager or manually the following depencies:
57+
3558
### Dependencies
3659
Before proceeding further, please install the following dependencies:
3760

@@ -63,6 +86,8 @@ In order to make the device detectable, add `<installation_path>/share/yarp` to
6386

6487
Alternatively, if `YARP` has been installed using the [robotology-superbuild](https://github.com/robotology/robotology-superbuild), it is possible to use `<directory-where-you-downloaded-robotology-superbuild>/build/install` as the `<installation_path>`.
6588

89+
## Usage
90+
6691
### How to use a RealSense D435
6792

6893
#### As `yarpmanager` application
@@ -116,7 +141,7 @@ You can write a yarp application to launch the camera and see the RGB and Depth
116141
:bulb: **NOTE:** When using YARP < 3.5, the final part of the `protocol` string should be changed from `+file.depthimage_to_rgb` to `+file.depthimage2`.
117142

118143

119-
#### From the command line
144+
### From the command line
120145

121146
Set the `YARP_ROBOT_NAME` to either `CER01`, `CER02` or `CER03`. Then, run the command:
122147

0 commit comments

Comments
 (0)