Skip to content

Commit

Permalink
Clarify docs on GH release install & C++ source build, remove reundan…
Browse files Browse the repository at this point in the history
…t rerun_cpp_sdk artifact (#6144)

### What

Minor doc cleanup plus removing redundant c++ sdk zip from future
artifacts:

The less verbose of these will no longer show up in the next release:

![image](https://github.com/rerun-io/rerun/assets/1220815/d1351f0b-74bd-448f-ab9e-908cfa4228a3)


### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested the web demo (if applicable):
* Using examples from latest `main` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/6144?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/6144?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG
* [x] If applicable, add a new check to the [release
checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)!

- [PR Build Summary](https://build.rerun.io/pr/6144)
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)

To run all checks from `main`, comment on the PR with `@rerun-bot
full-check`.
  • Loading branch information
Wumpf committed Apr 29, 2024
1 parent 6ae925a commit c385066
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/content/getting-started/installing-viewer.md
Original file line number Diff line number Diff line change
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
Original file line number Diff line number Diff line change
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
Original file line number Diff line number Diff line change
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

0 comments on commit c385066

Please sign in to comment.