Skip to content

Commit 151b47f

Browse files
committed
Update instructions and Rerun version
1 parent 4830834 commit 151b47f

File tree

2 files changed

+21
-4
lines changed

2 files changed

+21
-4
lines changed

CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ if(NOT DEFINED CMAKE_CXX_STANDARD)
99
endif()
1010

1111
include(FetchContent)
12-
FetchContent_Declare(rerun_sdk URL https://build.rerun.io/commit/f3a5ae2/rerun_cpp_sdk.zip)
12+
FetchContent_Declare(rerun_sdk URL https://build.rerun.io/commit/a8bb2f1/rerun_cpp_sdk.zip) # 2023-10-20
1313
FetchContent_MakeAvailable(rerun_sdk)
1414

1515
find_package(Eigen3 REQUIRED)

README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,30 @@
22

33
This is a minimal CMake project that shows how to use [Rerun](https://github.com/rerun-io/rerun) in your code in conjunction with [Eigen](https://eigen.tuxfamily.org/) and [OpenCV](https://opencv.org/).
44

5-
## How to build and run
5+
## Installing the Rerun viewer
6+
The Rerun C++ SDK works by connecting to an awaiting Rerun Viewer over TCP.
7+
8+
#### Building from source
9+
* [Install `cargo`](https://rustup.rs/)
10+
* `cargo install rerun-cli`
11+
12+
#### Using `pip`
13+
* `pip install rerun-sdk`
14+
15+
### Running the Rerun viewer
16+
Just type `rerun` and the rerun viewer should show up. Then it is time to run this example!
17+
18+
19+
## Run this example
620

721
### Using `pixi`
8-
The easiest way to get started is to install [pixi](https://prefix.dev/docs/pixi/overview) and then run: `pixi run run`.
22+
The easiest way to get started is to install [pixi](https://prefix.dev/docs/pixi/overview).
923

10-
### Manually
24+
* Start the rerun viewer with `rerun` (see above)
25+
* Run the example with `rerun run run`
1126

27+
28+
### Manually
1229
First install the required dependencies:
1330
* `arrow-cpp`` (required by Rerun)
1431
* `eigen` and `opencv` (required by this example)

0 commit comments

Comments
 (0)