Skip to content

Commit

Permalink
docs(readme): add installation and MSRV
Browse files Browse the repository at this point in the history
  • Loading branch information
jcornaz committed May 18, 2022
1 parent 3afc863 commit 5173784
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,23 @@ bvh.for_each_overlaping_pair(|a, b| println!("{a} overlaps {b}"));
This crate is `no_std` compatible but requires a [global allocator](https://doc.rust-lang.org/stable/core/alloc/trait.GlobalAlloc.html).


## Installation

Add to `Cargo.toml`:

```toml
bvh-arena = "1"
```

## MSRV

The minimum supported rust version is currently: `1.58`

**It *may* be increased to a newer stable version in a minor release.** (but only if needed)

It *will* be increased to the latest stable version in a major release. (even if not needed)


## Motivation

In the context of building my own collision detection logic, I wanted to use a bounding-volume-hierarchy (BVH)
Expand Down

0 comments on commit 5173784

Please sign in to comment.