Publish 0.4.0

README.md

@@ -1,9 +1,5 @@
 # Vulkano
 
-**Note: requires Rust 1.9**. This library would highly benefit from multiple upcoming features in
-Rust. Therefore it is likely that in the future you will need to update your version of Rust to
-continue using 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
@@ -14,23 +10,32 @@ What does vulkano do?
 - Provides a low-levelish API around Vulkan. It doesn't hide what it does, but provides some
   comfort types.
 - Plans to prevent all invalid API usages, even the most obscure ones. The purpose of vulkano
-  is not to draw a teapot, but to cover all possible usages of Vulkan and detect all the
+  is not to simply let you draw a teapot, but to cover all possible usages of Vulkan and detect all
-  possible problems. Invalid API usage is prevented thanks to both compile-time checks and
+  the possible problems in order to write robust programs. Invalid API usage is prevented thanks to
-  runtime checks.
+  both compile-time checks and runtime checks.
-- Handles synchronization on the GPU side for you, as this aspect of Vulkan is both annoying
+- Can handle synchronization on the GPU side for you (unless you choose do that yourself), as this
-  to handle and error-prone. Dependencies between submissions are automatically detected, and
+  aspect of Vulkan is both annoying to handle and error-prone. Dependencies between submissions are
-  semaphores are managed automatically. The behavior of the library can be customized thanks
+  automatically detected, and semaphores are managed automatically. The behavior of the library can
-  to unsafe trait implementations.
+  be customized thanks to unsafe trait implementations.
 - Tries to be convenient to use. Nobody is going to use a library that requires you to browse
   the documentation for hours for every single operation.
 
-**Warning: this library breaks every five minutes for the moment.**
-
 Note that vulkano does **not** require you to install the official Vulkan SDK. This is not
 something specific to vulkano (you don't need to SDK to write program that use Vulkan, even
 without vulkano), but many people are unaware of that and install the SDK thinking that it is
 required.
 
+## Development status
+
+**Please read this section.**
+
+The latest released version on crates.io is version 0.4. This version is not stable, and most
+likely differs from the code on github.
+
+Vulkano is still in heavy development and doesn't yet meet its goals of being very robust. However
+the general structure of the library is most likely definitive, and all future breaking changes
+will likely be straight-forward to fix in user code.
+
 ## [Documentation](https://docs.rs/vulkano)
 
 [![](https://docs.rs/vulkano/badge.svg)](https://docs.rs/vulkano)
@@ -40,26 +45,24 @@ the `triangle` example.
 
 ## Structure
 
-This repository contains four libraries:
+This repository contains five libraries:
 
 - `vulkano` is the main one.
 - `vulkano-shaders` can analyse SPIR-V shaders at compile-time.
+- `vulkano-shader-derive` provides a custom derive that invokes `vulkano-shaders`. It lets you
+  easily integrate your GLSL shaders within the rest of your source code.
 - `vulkano-win` provides a safe link between vulkano and the `winit` library which can create
   a window where to render to.
 - `glsl-to-spirv` can compile GLSL to SPIR-V by wrapping around `glslang`. `glsl-to-spirv` is an
   implementation detail that you don't need to use manually if you use vulkano.
 
-Once procedural macros are stabilized in Rust, the `vulkano-shaders` crate will be merged with the
+Once procedural macros are stabilized in Rust, the `vulkano-shaders` and `vulkano-shader-derive`
-`vulkano` crate. The `glsl-to-spirv` crate is an implementation detail of vulkano and is not
+crates will be merged with the `vulkano` crate. The `glsl-to-spirv` crate is an implementation
-supposed to be used directly if you use vulkano. You are, however, free to use it if you want to
+detail of vulkano and is not supposed to be used directly if you use vulkano. You are, however,
-write an alternative to vulkano.
+free to use it if you want to write an alternative to vulkano.
 
-This crate uses the Cargo workspaces feature that is available only in nightly, and whose purpose
+In order to run tests, run `cargo test --all` at the root of the repository. Make sure your Vulkan
-is to make several crates share the same `target/` directory. It is normal to get an error if you
+driver is up to date before doing so.
-try to run `cargo build` at the root of the directory.
-
-In order to run tests, go to the `vulkano` subdirectory and run `cargo test`. Make sure your
-Vulkan driver is up to date before doing so.
 
 ## License
 

vk-sys/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "vk-sys"
-version = "0.2.2"
+version = "0.2.3"
 authors = ["Pierre Krieger <pierre.krieger1708@gmail.com>"]
 repository = "https://github.com/tomaka/vulkano"
 description = "Bindings for the Vulkan graphics API"

vulkano-shader-derive/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "vulkano-shader-derive"
-version = "0.3.2"
+version = "0.4.0"
 authors = ["Pierre Krieger <pierre.krieger1708@gmail.com>"]
 repository = "https://github.com/tomaka/vulkano"
 description = "Safe wrapper for the Vulkan graphics API"
@@ -15,4 +15,4 @@ proc-macro = true
 [dependencies]
 glsl-to-spirv = { version = "0.1.2", path = "../glsl-to-spirv" }
 syn = { version = "0.10", features = ["aster", "visit"] }
-vulkano-shaders = { version = "0.3", path = "../vulkano-shaders" }
+vulkano-shaders = { version = "0.4", path = "../vulkano-shaders" }

vulkano-shaders/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "vulkano-shaders"
-version = "0.3.2"
+version = "0.4.0"
 authors = ["Pierre Krieger <pierre.krieger1708@gmail.com>"]
 repository = "https://github.com/tomaka/vulkano"
 description = "Shaders "

vulkano-win/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "vulkano-win"
-version = "0.3.2"
+version = "0.4.0"
 authors = ["Pierre Krieger <pierre.krieger1708@gmail.com>"]
 repository = "https://github.com/tomaka/vulkano"
 description = "Link between vulkano and winit"
@@ -8,7 +8,7 @@ license = "MIT/Apache-2.0"
 categories = ["rendering::graphics-api"]
 
 [dependencies]
-vulkano = { version = "0.3.0", path = "../vulkano" }
+vulkano = { version = "0.4.0", path = "../vulkano" }
 winit = "0.6.4"
 
 [target.'cfg(target_os = "macos")'.dependencies]

vulkano/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "vulkano"
-version = "0.3.2"
+version = "0.4.0"
 authors = ["Pierre Krieger <pierre.krieger1708@gmail.com>"]
 repository = "https://github.com/tomaka/vulkano"
 description = "Safe wrapper for the Vulkan graphics API"
@@ -15,4 +15,4 @@ fnv = "1.0.5"
 shared_library = "0.1.5"
 smallvec = "0.3.1"
 lazy_static = "0.2.2"
-vk-sys = { version = "0.2.2", path = "../vk-sys" }
+vk-sys = { version = "0.2.3", path = "../vk-sys" }