Skip to content

Commit 514fe71

Browse files
docs: docs.rs link and install instructions
1 parent 0a41b82 commit 514fe71

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
[![arXiv CAPT](https://img.shields.io/badge/arXiv-2406.02807-b31b1b.svg)](https://arxiv.org/abs/2406.02807)
44
[![Crates.io page](https://img.shields.io/crates/v/capt)](https://crates.io/crates/capt)
5+
[![docs.rs](https://img.shields.io/docsrs/capt)](https://docs.rs/capt)
56

67
![Demo video](doc/capt_demo.gif)
78

@@ -52,6 +53,21 @@ assert!(!captree.collides(&[1.5, 1.5], 0.01));
5253
assert!(captree.collides(&[1.5, 1.5], 0.01));
5354
```
5455

56+
## Installation
57+
58+
`capt` is available as a package on [crates.io](https://crates.io/crate/capt).
59+
This means that adding `capt` to your Rust project is as simple as asking Cargo to add it as a dependency.
60+
61+
```sh
62+
cargo add capt
63+
```
64+
65+
To use the SIMD-parallel features of CAPTs, make sure to include it as a feature.
66+
67+
```sh
68+
cargo add capt --features simd
69+
```
70+
5571
## License
5672

5773
This work is licensed to you under the Apache 2.0 license.

0 commit comments

Comments
 (0)