nordic-dev.net/rust-gpu
2
0
Fork 0
mirror of https://github.com/EmbarkStudios/rust-gpu.git synced 2024-11-22 06:45:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add introduction to API docs (#189)

Browse Source
This commit is contained in:
XAMPPRocky 2020-10-30 15:20:12 +01:00 committed by GitHub
parent aef85ea5d8
commit 2a19fc1cb7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
rustc_codegen_spirv/src/lib.rs
View File

@ -1,3 +1,20 @@
//! Welcome to the API documentation for the `rust-gpu` project, this API is
//! unstable and mainly intended for developing on the project itself. This is
//! the API documentation for `rustc_codegen_spirv` which is not that useful on
//! its own. You might also be interested in the following crates. There's also
//! the [Rust GPU Dev Guide][gpu-dev-guide] which contains more user-level
//! information on how to use and setup `rust-gpu`.
//!
//! - [`spriv-builder`]
//! - [`spriv-std`]
//! - [`spriv-tools`]
//! - [`spriv-tools-sys`]
//!
//! [gpu-dev-guide]: https://embarkstudios.github.io/rust-gpu/book
//! [`spriv-builder`]: https://embarkstudios.github.io/rust-gpu/api/spirv_builder
//! [`spriv-std`]: https://embarkstudios.github.io/rust-gpu/api/spirv_std
//! [`spriv-tools`]: https://embarkstudios.github.io/rust-gpu/api/spirv_tools
//! [`spriv-tools-sys`]: https://embarkstudios.github.io/rust-gpu/api/spirv_tools_sys
#![feature(rustc_private)]
#![feature(once_cell)]
#![deny(clippy::unimplemented, clippy::ok_expect, clippy::mem_forget)]