mirror of
https://github.com/gfx-rs/wgpu.git
synced 2025-12-08 21:26:17 +00:00
Update CTS section in README (#7762)
* Update CTS section in README * gitignore `cts` it even if it is a symlink, but always limit to the repo root.
This commit is contained in:
parent
55fd09786a
commit
6c7f934af6
2
.gitignore
vendored
2
.gitignore
vendored
@ -34,7 +34,7 @@ wgpu/red.png
|
||||
**/*-difference.png
|
||||
|
||||
# Readme says to check out CTS here
|
||||
cts/
|
||||
/cts
|
||||
|
||||
# Readme says to put angle in working directory
|
||||
*.dll
|
||||
|
||||
16
README.md
16
README.md
@ -212,20 +212,17 @@ If you are a user and want a way to help contribute to wgpu, we always need more
|
||||
|
||||
### WebGPU Conformance Test Suite
|
||||
|
||||
WebGPU includes a Conformance Test Suite to validate that implementations are working correctly. We can run this CTS against wgpu.
|
||||
WebGPU includes a Conformance Test Suite to validate that implementations are
|
||||
working correctly. We run cases from the CTS against wgpu using
|
||||
[Deno](https://deno.com/). A [default list of enabled
|
||||
tests](./cts_runner/test.lst) is automatically run on pull requests in CI.
|
||||
|
||||
To have GitHub run the CTS against a pull request, you can add the `PR: run CTS` label to the PR.
|
||||
|
||||
To run the CTS locally, run:
|
||||
To run the default set of CTS tests locally, run:
|
||||
|
||||
```
|
||||
cargo xtask cts
|
||||
```
|
||||
|
||||
This will clone the CTS into the `cts` directory, check out the
|
||||
[pinned version](./cts_runner/revision.txt), and run the
|
||||
[default list of enabled tests](./cts_runner/test.lst).
|
||||
|
||||
You can also specify a test selector on the command line:
|
||||
|
||||
```
|
||||
@ -241,6 +238,9 @@ cargo xtask cts -f your_tests.lst
|
||||
To find the full list of tests, go to the
|
||||
[web version of the CTS](https://gpuweb.github.io/cts/standalone/?runnow=0&worker=0&debug=0&q=webgpu:*).
|
||||
|
||||
The version of the CTS used by `cargo xtask cts` is specified in
|
||||
[`cts_runner/revision.txt`](./cts_runner/revision.txt).
|
||||
|
||||
## Tracking the WebGPU and WGSL draft specifications
|
||||
|
||||
The `wgpu` crate is meant to be an idiomatic Rust translation of the [WebGPU API][webgpu spec].
|
||||
|
||||
@ -68,7 +68,7 @@ fn main() -> anyhow::Result<ExitCode> {
|
||||
|
||||
let mut args = Arguments::from_env();
|
||||
|
||||
if args.contains("--help") {
|
||||
if args.contains(["-h", "--help"]) {
|
||||
eprint!("{HELP}");
|
||||
return Ok(ExitCode::FAILURE);
|
||||
}
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user