Skip to content

Commit b60f408

Browse files
committed
Add a README.md
1 parent 7c88680 commit b60f408

File tree

3 files changed

+38
-1
lines changed

3 files changed

+38
-1
lines changed

crates/rerun-cli/README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<h1 align="center">
2+
<a href="https://www.rerun.io/">
3+
<img alt="banner" src="https://user-images.githubusercontent.com/1148717/218142418-1d320929-6b7a-486e-8277-fbeef2432529.png">
4+
</a>
5+
</h1>
6+
7+
<h1 align="center">
8+
<a href="https://crates.io/crates/rerun-cli"> <img alt="Latest version" src="https://img.shields.io/crates/v/rerun-cli.svg"> </a>
9+
<a href="https://docs.rs/rerun-cli"> <img alt="Documentation" src="https://docs.rs/rerun-cli/badge.svg"> </a>
10+
<a href="https://github.com/rerun-io/rerun/blob/master/LICENSE-MIT"> <img alt="MIT" src="https://img.shields.io/badge/license-MIT-blue.svg"> </a>
11+
<a href="https://github.com/rerun-io/rerun/blob/master/LICENSE-APACHE"> <img alt="Apache" src="https://img.shields.io/badge/license-Apache-blue.svg"> </a>
12+
<a href="https://discord.gg/Gcm8BbTaAj"> <img alt="Rerun Discord" src="https://img.shields.io/discord/1062300748202921994?label=Rerun%20Discord"> </a>
13+
</h1>
14+
15+
## Rerun command-line tool
16+
You can install the binary with `cargo install rerun-cli`
17+
18+
This can act either as a server, a viewer, or both, depending on which options you use when you start it.
19+
20+
Running `rerun` with no arguments will start the viewer, waiting for an SDK to connect to it over TCP.
21+
22+
Run `rerun --help` for more.
23+
24+
25+
## What is Rerun?
26+
- [Examples](https://github.com/rerun-io/rerun/tree/latest/examples/rust)
27+
- [High-level docs](http://rerun.io/docs)
28+
- [Rust API docs](https://docs.rs/rerun/)
29+
- [Troubleshooting](https://www.rerun.io/docs/getting-started/troubleshooting)
30+
31+
32+
### Running a web viewer
33+
```sh
34+
rerun --web-viewer ../nyud.rrd
35+
```

crates/rerun-cli/src/bin/rerun.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
//! The `rerun` binary.
2+
//!
3+
//! Run `rerun --help` for more information.
14
use re_memory::AccountingAllocator;
25

36
#[global_allocator]

crates/rerun/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,5 @@ Run `rerun --help` for more.
5959
The web viewer is an experimental feature, but you can try it out with:
6060
6161
```sh
62-
cargo install --features web rerun
6362
rerun --web-viewer ../nyud.rrd
6463
```

0 commit comments

Comments
 (0)