Skip to content

Commit

Permalink
Merge pull request #14 from rerun-io/jleibs/pixi_rerun
Browse files Browse the repository at this point in the history
Add `rerun-sdk` to the pixi.toml
  • Loading branch information
emilk authored Oct 31, 2023
2 parents 78dc29e + dc06f70 commit ad236da
Show file tree
Hide file tree
Showing 4 changed files with 7,420 additions and 4,257 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/cpp.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:

- uses: prefix-dev/[email protected]
with:
pixi-version: v0.5.0
pixi-version: v0.6.0
cache: true

- run: pixi run build
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,17 @@ This is a minimal CMake project that shows how to use [Rerun](https://github.com
</picture>
</center>

## Installing the Rerun viewer
## Using `pixi`
The easiest way to get started is to install [pixi](https://prefix.dev/docs/pixi/overview).

The pixi environment described in `pixi.toml` contains all of the dependencies, including the rerun viewer,
allowing you to run the example with a single command:
* `pixi run example`

## Without `pixi`
If you choose not to use pixi, you will need to install a few things yourself before you get started.

### Installing the Rerun Viewer
The Rerun C++ SDK works by connecting to an awaiting Rerun Viewer over TCP.

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:
Expand All @@ -21,22 +31,13 @@ If you need to install the viewer, follow the [installation guide](https://www.r

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

## Run this example

### Using `pixi`
The easiest way to get started is to install [pixi](https://prefix.dev/docs/pixi/overview).

* Start the rerun viewer with `rerun` (see above)
* Run the example with `pixi run example`


### Manually
First install the required dependencies:
### Installing dependencies:
This project depends on a few libraries and toolchains. Installing these is outside the scope of this README,
but your OS should have these available though a common package manager:
* `eigen` and `opencv` (required by this example)
* `cmake` (for building)


### Linux & Mac
### Build and run on Linux & Mac

Build:
```bash
Expand All @@ -48,8 +49,7 @@ Then run the binary with:
`build/rerun_ext_example`


### Windows using Visual Studio 2022

### Build and run on Windows using Visual Studio 2022

Build
```cmd
Expand Down
Loading

0 comments on commit ad236da

Please sign in to comment.