Skip to content

Add a C++ quick-start to the viewer#3961

Merged
emilk merged 11 commits intomainfrom
emilk/cpp-quick-start
Oct 24, 2023
Merged

Add a C++ quick-start to the viewer#3961
emilk merged 11 commits intomainfrom
emilk/cpp-quick-start

Conversation

@emilk
Copy link
Copy Markdown
Member

@emilk emilk commented Oct 23, 2023 •
edited by github-actions bot
Loading

What

Checklist

  • I have read and agree to Contributor Guide and the Code of Conduct
  • I've included a screenshot or gif (if applicable)
  • I have tested demo.rerun.io (if applicable)
  • The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG

@emilk emilk added 📖 documentation Improvements or additions to documentation examples Issues relating to the Rerun examples sdk-cpp C/C++ API specific exclude from changelog PRs with this won't show up in CHANGELOG.md labels Oct 23, 2023
emilk
emilk commented Oct 23, 2023
View reviewed changes
crates/re_viewer/data/quick_start_guides/cpp_connect.md

```cmake
include(FetchContent)
FetchContent_Declare(rerun_sdk URL https://build.rerun.io/commit/06dd483/rerun_cpp_sdk.zip) # 2023-10-20
Copy link
Copy Markdown
Member Author

@emilk emilk Oct 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Obviously we'll have to update this before the release. I've added a TODO to #3962

@Wumpf Wumpf self-requested a review October 23, 2023 14:42
teh-cmc
teh-cmc reviewed Oct 23, 2023
View reviewed changes
crates/re_viewer/data/quick_start_guides/cpp_connect.md

```cmake
include(FetchContent)
FetchContent_Declare(rerun_sdk URL https://build.rerun.io/commit/06dd483/rerun_cpp_sdk.zip) # 2023-10-20
Copy link
Copy Markdown
Contributor

@teh-cmc teh-cmc Oct 23, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
FetchContent_Declare(rerun_sdk URL https://build.rerun.io/commit/06dd483/rerun_cpp_sdk.zip) # 2023-10-20
FetchContent_Declare(rerun_sdk URL https://github.com/rerun-io/rerun/releases/latest/download/rerun_cpp_sdk.zip)

Copy link
Copy Markdown
Member Author

@emilk emilk Oct 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

404

Copy link
Copy Markdown
Contributor

@teh-cmc teh-cmc Oct 23, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah it will 404 until we have a cpp release. We can ship an rc1 tomorrow I guess?

Copy link
Copy Markdown
Contributor

@teh-cmc teh-cmc Oct 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've temporarily added the C++ sdk as an asset of the 0.9.1 release so we can test our links.

Copy link
Copy Markdown
Member

@Wumpf Wumpf Oct 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'latest' is actually a bad idea for a users's cmake script. Because then it auto-updates when we bring out a new latest

Copy link
Copy Markdown
Contributor

@teh-cmc teh-cmc Oct 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/rerun-io/rerun/releases/download/0.10.0/rerun_cpp_sdk.zip then

Wumpf
Wumpf approved these changes Oct 23, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@Wumpf Wumpf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice! Finally some sane getting started documentation \o/

@emilk emilk merged commit 563e508 into main Oct 24, 2023
@emilk emilk deleted the emilk/cpp-quick-start branch October 24, 2023 08:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Wumpf Wumpf Wumpf approved these changes

+1 more reviewer

@teh-cmc teh-cmc teh-cmc left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

📖 documentation Improvements or additions to documentation examples Issues relating to the Rerun examples exclude from changelog PRs with this won't show up in CHANGELOG.md sdk-cpp C/C++ API specific

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add C++ to in-viewer quick-start guide

3 participants

@emilk @Wumpf @teh-cmc