Skip to content

Commit 6129f94

Browse files
committed
Update the readme
1 parent 0e10b1d commit 6129f94

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,17 @@ This is a minimal CMake project that shows how to use [Rerun](https://github.com
1212
</picture>
1313
</center>
1414

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
1626
The Rerun C++ SDK works by connecting to an awaiting Rerun Viewer over TCP.
1727

1828
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
2131

2232
After you have installed it, you should be able to type `rerun` in your terminal to start the viewer.
2333

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:
3537
* `eigen` and `opencv` (required by this example)
3638
* `cmake` (for building)
3739

38-
39-
### Linux & Mac
40+
### Build and run on Linux & Mac
4041

4142
Build:
4243
```bash
@@ -48,8 +49,7 @@ Then run the binary with:
4849
`build/rerun_ext_example`
4950

5051

51-
### Windows using Visual Studio 2022
52-
52+
### Build and run on Windows using Visual Studio 2022
5353

5454
Build
5555
```cmd

0 commit comments

Comments
 (0)