You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,17 @@ This is a minimal CMake project that shows how to use [Rerun](https://github.com
12
12
</picture>
13
13
</center>
14
14
15
-
## Installing the Rerun viewer
15
+
## Using `pixi`
16
+
The easiest way to get started is to install [pixi](https://prefix.dev/docs/pixi/overview).
17
+
18
+
The pixi environment described in `pixi.toml` contains all of the dependencies, including the rerun viewer,
19
+
allowing you to run the example with a single command:
20
+
*`pixi run example`
21
+
22
+
## Without `pixi`
23
+
If you choose not to use pixi, you will need to install a few things yourself before you get started.
24
+
25
+
### Installing the Rerun Viewer
16
26
The Rerun C++ SDK works by connecting to an awaiting Rerun Viewer over TCP.
17
27
18
28
If you need to install the viewer, follow the [installation guide](https://www.rerun.io/docs/getting-started/installing-viewer). Two of the more common ways to install the Rerun are:
@@ -21,22 +31,13 @@ If you need to install the viewer, follow the [installation guide](https://www.r
21
31
22
32
After you have installed it, you should be able to type `rerun` in your terminal to start the viewer.
23
33
24
-
## Run this example
25
-
26
-
### Using `pixi`
27
-
The easiest way to get started is to install [pixi](https://prefix.dev/docs/pixi/overview).
28
-
29
-
* Start the rerun viewer with `rerun` (see above)
30
-
* Run the example with `pixi run example`
31
-
32
-
33
-
### Manually
34
-
First install the required dependencies:
34
+
### Installing dependencies:
35
+
This project depends on a few libraries and toolchains. Installing these is outside the scope of this README,
36
+
but your OS should have these available though a common package manager:
35
37
*`eigen` and `opencv` (required by this example)
36
38
*`cmake` (for building)
37
39
38
-
39
-
### Linux & Mac
40
+
### Build and run on Linux & Mac
40
41
41
42
Build:
42
43
```bash
@@ -48,8 +49,7 @@ Then run the binary with:
48
49
`build/rerun_ext_example`
49
50
50
51
51
-
### Windows using Visual Studio 2022
52
-
52
+
### Build and run on Windows using Visual Studio 2022
0 commit comments