Skip to content

Commit

Permalink
Add example of downloading rerun c++ lib via pixi
Browse files Browse the repository at this point in the history
  • Loading branch information
traversaro committed May 19, 2024
1 parent cae61c0 commit dcbc585
Show file tree
Hide file tree
Showing 5 changed files with 4,318 additions and 3,289 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Build directory
# Build directories
build
buildrerunfindpackage

# Pixi environment
.pixi
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ if(NOT DEFINED CMAKE_CXX_STANDARD)
set(CMAKE_CXX_STANDARD 17)
endif()

set(RERUN_CPP_URL "https://github.com/rerun-io/rerun/releases/download/0.15.1/rerun_cpp_sdk.zip" CACHE STRING "URL to the rerun_cpp zip.")
set(RERUN_CPP_URL "https://github.com/rerun-io/rerun/releases/download/0.16.0/rerun_cpp_sdk.zip" CACHE STRING "URL to the rerun_cpp zip.")
option(RERUN_FIND_PACKAGE "Whether to use find_package to find a preinstalled rerun package (instead of using FetchContent)." OFF)

if(RERUN_FIND_PACKAGE)
Expand Down
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,11 @@ This is a minimal CMake project that shows how to use [Rerun](https://github.com
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`
allowing you to run the example with a single command, while the rerun C++ SDK is downloaded via `FetchContent`
* `pixi run -e default example`

If you want to also download rerun C++ SDK via pixi, you can run:
* `pixi run -e rerundfindpackage example`

Check warning on line 23 in README.md

View workflow job for this annotation

GitHub Actions / Spellcheck

Unknown word (rerundfindpackage)

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

0 comments on commit dcbc585

Please sign in to comment.