|
2 | 2 |
|
3 | 3 | //! Rust GPU shader crate builder.
|
4 | 4 | //!
|
5 |
| -//! This program and library allows you to easily compile your rust-gpu shaders, |
| 5 | +//! This library allows you to easily compile your rust-gpu shaders, |
6 | 6 | //! without requiring you to fix your entire project to a specific toolchain.
|
7 | 7 | //!
|
8 | 8 | //! # How it works
|
9 | 9 | //!
|
10 |
| -//! This program primarily manages installations of `rustc_codegen_spirv`, the |
| 10 | +//! This library primarily manages installations of `rustc_codegen_spirv`, the |
11 | 11 | //! codegen backend of rust-gpu to generate SPIR-V shader binaries. The codegen
|
12 | 12 | //! backend builds on internal, ever-changing interfaces of rustc, which requires
|
13 | 13 | //! fixing a version of rust-gpu to a specific version of the rustc compiler.
|
|
17 | 17 | //!
|
18 | 18 | //! We continue to use rust-gpu's `spirv_builder` crate to pass the many additional
|
19 | 19 | //! parameters required to configure rustc and our codegen backend, but provide you
|
20 |
| -//! with a toolchain agnostic version that you may use from stable rustc. And a |
21 |
| -//! `cargo gpu` cmdline utility to simplify shader building even more. |
| 20 | +//! with a toolchain agnostic version that you may use from stable rustc. |
| 21 | +//! And a `cargo gpu` command line utility to simplify shader building even more. |
22 | 22 | //!
|
23 | 23 | //! ## Where the binaries are
|
24 | 24 | //!
|
25 |
| -//! We store our prebuild `rustc_spirv_builder` binaries in the default cache |
| 25 | +//! We store our prebuilt `rustc_spirv_builder` binaries in the default cache |
26 | 26 | //! directory of your OS:
|
27 | 27 | //! * Windows: `C:/users/<user>/AppData/Local/rust-gpu`
|
28 | 28 | //! * Mac: `~/Library/Caches/rust-gpu`
|
|
0 commit comments