Skip to content

Commit

Permalink
Add bibtex citation to README.md (rerun-io#5325)
Browse files Browse the repository at this point in the history
### What

What the title say ☝🏻 

### 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 newly built examples:
[app.rerun.io](https://app.rerun.io/pr/5325/index.html)
* Using examples from latest `main` build:
[app.rerun.io](https://app.rerun.io/pr/5325/index.html?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[app.rerun.io](https://app.rerun.io/pr/5325/index.html?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/5325)
- [Docs
preview](https://rerun.io/preview/a144a089de72371835f9fd598da63d1d5ed64618/docs)
<!--DOCS-PREVIEW-->
- [Examples
preview](https://rerun.io/preview/a144a089de72371835f9fd598da63d1d5ed64618/examples)
<!--EXAMPLES-PREVIEW-->
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)
  • Loading branch information
abey79 authored Feb 28, 2024
1 parent 53d5174 commit d68f449
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,31 @@ In the future, Rerun will offer a commercial product that builds on top of the c
The Rerun open source project targets the needs of individual developers.
The commercial product targets the needs specific to teams that build and run computer vision and robotics products.

## How to Cite Rerun

When using Rerun in your research, please cite it to acknowledge its contribution to your work. This can be done by
including a reference to Rerun in the software or methods section of your paper.

Suggested citation format:

```bibtex
@software{RerunSDK,
title = {Rerun: A Visualization SDK for Multimodal Data},
author = {{Rerun Development Team}},
url = {https://www.rerun.io},
version = {insert version number},
date = {insert date of usage},
year = {2024},
publisher = {{Rerun Technologies AB}},
address = {Online},
note = {Available from https://www.rerun.io/ and https://github.com/rerun-io/rerun}
}
```

Please replace "insert version number" with the version of Rerun you used and "insert date of usage" with the date(s)
you used the tool in your research.
This citation format helps ensure that Rerun's development team receives appropriate credit for their work and
facilitates the tool's discovery by other researchers.

# Development
* [`ARCHITECTURE.md`](ARCHITECTURE.md)
Expand Down
1 change: 1 addition & 0 deletions docs/cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
"Bazel",
"Bgra",
"Bhat",
"bibtex",
"bindgen",
"bindgroup",
"binsearch",
Expand Down

0 comments on commit d68f449

Please sign in to comment.