Skip to content

Commit

Permalink
Make examples setup a separate page (#2323)
Browse files Browse the repository at this point in the history
<!--
Open the PR up as a draft until you feel it is ready for a proper
review.

Do not make PR:s from your own `main` branch, as that makes it difficult
for reviewers to add their own fixes.

Add any improvements to the branch as new commits to make it easier for
reviewers to follow the progress. All commits will be squashed to a
single commit once the PR is merged into `main`.

Make sure you mention any issues that this PR closes in the description,
as well as any other related issues.

To get an auto-generated PR description you can put "copilot:summary" or
"copilot:walkthrough" anywhere.
-->

### What

### Checklist
* [ ] 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)
* [ ] I've included a screenshot or gif (if applicable)

<!-- This line will get updated when the PR build summary job finishes.
-->
PR Build Summary: https://build.rerun.io/pr/2323

<!-- pr-link-docs:start -->
Docs preview: https://rerun.io/preview/1f66e4b/docs
Examples preview: https://rerun.io/preview/1f66e4b/examples
<!-- pr-link-docs:end -->
  • Loading branch information
jprochazk authored and emilk committed Jun 15, 2023
1 parent b20063e commit e90e8b0
Showing 1 changed file with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions examples/manifest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,21 +39,22 @@ root:
clone of the repository. Many of the Python examples need additional dependencies
set up in a `requirements.txt` next to the example. These are noted in the
individual example sections below.
## Setup
Make sure you have the Rerun repository checked out and the latest SDK installed.
```bash
pip install --upgrade rerun-sdk # install the latest Rerun SDK
git clone [email protected]:rerun-io/rerun.git # Clone the repository
cd rerun
git checkout latest # Check out the commit matching the latest SDK release
```
> Note: Make sure your SDK version matches the examples.
For example, if your SDK version is `0.3.1`, check out the matching tag
in the Rerun repository by running `git checkout v0.3.1`.
children:
- name: setup
title: Setup
prelude: |
Make sure you have the Rerun repository checked out and the latest SDK installed.
```bash
pip install --upgrade rerun-sdk # install the latest Rerun SDK
git clone [email protected]:rerun-io/rerun.git # Clone the repository
cd rerun
git checkout latest # Check out the commit matching the latest SDK release
```
> Note: Make sure your SDK version matches the examples.
For example, if your SDK version is `0.3.1`, check out the matching tag
in the Rerun repository by running `git checkout v0.3.1`.
- name: artificial-data
title: Examples with Artificial Data
prelude: |
Expand Down

0 comments on commit e90e8b0

Please sign in to comment.