mirror of
https://github.com/vulkano-rs/vulkano.git
synced 2024-11-25 08:14:20 +00:00
Add introduction paragraph to README
This commit is contained in:
parent
eb99ccb11d
commit
45dd6d8156
@ -1,5 +1,13 @@
|
||||
# Vulkano
|
||||
|
||||
Vulkano is a Rust wrapper around [the Vulkan graphics API](https://www.khronos.org/vulkan/).
|
||||
It follows the Rust philosophy, which is that as long as you don't use unsafe code you shouldn't
|
||||
be able to trigger any undefined behavior. In the case of Vulkan, this means that non-unsafe code
|
||||
should always conform to valid API usage.
|
||||
|
||||
Vulkano is *not* a high level library. It provides only the minimal features required to make
|
||||
using the Vulkan API safe.
|
||||
|
||||
*Warning: this library breaks every five minutes for the moment.*
|
||||
|
||||
## [Documentation](http://tomaka.github.io/vulkano/vulkano/index.tml)
|
||||
|
Loading…
Reference in New Issue
Block a user