Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify docs on GH release install & C++ source build, remove reundant rerun_cpp_sdk artifact #6144

Merged
merged 4 commits into from Apr 29, 2024
Merged

Clarify docs on GH release install & C++ source build, remove reundant rerun_cpp_sdk artifact #6144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
51c76ac
clarify that the cmake setup builds c++ from source
Wumpf Apr 28, 2024
68327f3
clarify that the rerun-cli github artifact is the viwer
Wumpf Apr 28, 2024
6d1babc
don't add rerun_sdk_zip redundant to rerun_cpp_sdk-<version>-multipla…
Wumpf Apr 28, 2024
0883042
Merge branch 'main' into andreas/cpp-setup-clarifications
Wumpf Apr 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/content/getting-started/installing-viewer.md
View file
Open in desktop
Expand Up @@ -37,7 +37,7 @@ Make sure that your library version matches the version of the Viewer you're usi

There are many ways to install the viewer. Please pick whatever works best for your setup:

- Download it from the [GitHub Release artifacts](https://github.com/rerun-io/rerun/releases/latest/)
- Download `rerun-cli` for your platform from the [GitHub Release artifacts](https://github.com/rerun-io/rerun/releases/latest/).
- Via Cargo
- `cargo binstall rerun-cli` - download binaries via [`cargo binstall`](https://github.com/cargo-bins/cargo-binstall)
- `cargo install rerun-cli` - build it from source (this requires Rust 1.76+)
Expand Down
8 changes: 4 additions & 4 deletions rerun_cpp/README.md
View file
Open in desktop
Expand Up @@ -62,13 +62,13 @@ Check the [general doc page on types](https://www.rerun.io/docs/reference/types)

### Overview

To avoid compatibility issues across different platforms, compiler versions and C++ standard library versions
the C++ SDK is expected to be built from source.

From a build system perspective, the SDK consists of three dependencies:

* [SDK source](https://github.com/rerun-io/rerun/tree/latest/rerun_cpp/src/)
* [C++ SDK source](https://github.com/rerun-io/rerun/tree/latest/rerun_cpp/src/)
* This includes **both** source and header files!
* To avoid compatibility issues across different platforms, compiler versions and C++ standard library versions
we recommend to build the C++ SDK directly from source.
Note that this also what happens when you follow the CMake setup in the [quickstart guide](https://www.rerun.io/docs/getting-started/quick-start/cpp).
* [rerun_c](https://github.com/rerun-io/rerun/tree/latest/crates/rerun_c/) static libraries
* Rerun C is a minimal C SDK and forms the bridge to the shared Rust codebase
* Due to the rigidity of the C ABI and lack of complex standard library types in the interface,
Expand Down
2 changes: 0 additions & 2 deletions scripts/ci/sync_release_assets.py
View file
Open in desktop
Expand Up @@ -129,8 +129,6 @@ def fetch_binary_assets(
if blob is not None and blob.name is not None:
name = blob.name.split("/")[-1]
print(f"Found Rerun cross-platform bundle: {name}")
assets[name] = blob
# NOTE: Want a versioned one too.
assets[f"rerun_cpp_sdk-{tag}-multiplatform.zip"] = blob
else:
all_found = False
Expand Down