Skip to content

Commit 8d2dd25

Browse files
committed
update README
1 parent 62ba83d commit 8d2dd25

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

README.md

7.1 KB

Banner

[dependencies]
gpu-allocator = { version = "0.27.0" }
gpu-allocator = "0.27.0"

Visualizer

no_std Support

no_std support can be enabled by compiling with --no-default-features to disable std support and --features hashbrown for Hash collections that are only defined in std for internal usages in crate. For example:

[dependencies]
gpu-allocator = { version = "0.27.0", default-features = false, features = ["hashbrown", "other features"] }
gpu-allocator = { version = "0.27", default-features = false, features = ["hashbrown", "other features"] }

To support both std and no_std builds in project, you can use the following in your Cargo.toml:

[features]
default = ["std", "other features"]

std = ["gpu-allocator/std"]
hashbrown = ["gpu-allocator/hashbrown"]
other_features = []

[dependencies]
gpu-allocator = { version = "0.27.0", default-features = false }
gpu-allocator = { version = "0.27", default-features = false }

Minimum Supported Rust Version

The MSRV for this crate and the vulkan, d3d12 and metal features is Rust 1.71.

The no_std support requires version aboveRust 1.81 beacuaseor higher because no_std support of dependency thiserror requires core::error::Error which is stabalizedstabilized in 1.81.

Any other features such as the visualizer (with all the egui dependencies) may have a higher requirement and are not tested in our CI.

README.tpl

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
```toml
1414
[dependencies]
15-
gpu-allocator = "0.27.0"
15+
gpu-allocator = { version = "0.27.0" }
1616
```
1717

1818
![Visualizer](visualizer.png)
@@ -27,7 +27,7 @@ defined in `std` for internal usages in crate. For example:
2727

2828
```toml
2929
[dependencies]
30-
gpu-allocator = { version = "0.27", default-features = false, features = ["hashbrown", "other features"] }
30+
gpu-allocator = { version = "0.27.0", default-features = false, features = ["hashbrown", "other features"] }
3131
```
3232

3333
To support both `std` and `no_std` builds in project, you can use the following
@@ -42,14 +42,14 @@ hashbrown = ["gpu-allocator/hashbrown"]
4242
other_features = []
4343

4444
[dependencies]
45-
gpu-allocator = { version = "0.27", default-features = false }
45+
gpu-allocator = { version = "0.27.0", default-features = false }
4646
```
4747

4848
## Minimum Supported Rust Version
4949

5050
The MSRV for this crate and the `vulkan`, `d3d12` and `metal` features is Rust **1.71**.
5151

52-
The `no_std` support requires version above **1.81** beacuase `no_std` support of dependency `thiserror` requires `core::error::Error` which is stabalized in **1.81**.
52+
The `no_std` support requires Rust **1.81** or higher because `no_std` support of dependency `thiserror` requires `core::error::Error` which is stabilized in **1.81**.
5353

5454
Any other features such as the `visualizer` (with all the `egui` dependencies) may have a higher requirement and are not tested in our CI.
5555

0 commit comments

Comments
 (0)