Skip to content

Commit

Permalink
Updated documentation to use docs.rs
Browse files Browse the repository at this point in the history
  • Loading branch information
Osspial committed Dec 4, 2016
1 parent 132a3b7 commit b4f505f
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 2 deletions.
1 change: 1 addition & 0 deletions vk_api/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ authors = ["Osspial <[email protected]>"]

description = "The Vulkan API XML exposed as a byte string constant"
repository = "https://github.com/Osspial/vk-rs"
documentation = "https://docs.rs/vk_api/"
readme = "README.md"

keywords = ["vulkan", "khronos"]
Expand Down
2 changes: 2 additions & 0 deletions vk_api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ The [Vulkan API](https://github.com/KhronosGroup/Vulkan-Docs) XML exposed as byt
Version is equal to the Vulkan version exposed - i.e. vk_api 1.0.0 exposes the vulkan 1.0.0 xml, vk_api
1.0.6 exposes the vulkan 1.0.6 xml, etc.

## [Documentation](https://docs.rs/vk_api/)

```toml
[build-dependencies]
vk_api = "1.0"
Expand Down
3 changes: 2 additions & 1 deletion vk_generator/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ authors = ["Osspial <[email protected]>"]

description = "Generate Rust bindings to the Vulkan API"
repository = "https://github.com/Osspial/vk-rs"
documentation = "http://osspial.github.io/vk-rs/vk_generator/index.html"
documentation = "https://docs.rs/vk_generator/"
readme = "./README.md"

keywords = ["vulkan", "khronos"]
license = "MIT"
Expand Down
2 changes: 1 addition & 1 deletion vk_generator/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# vk_generator [![Version](https://img.shields.io/crates/v/vk_generator.svg)](https://crates.io/crates/vk_generator)
Rust binding generator for the [Vulkan API](https://www.khronos.org/vulkan/).

## [Documentation](http://osspial.github.io/vk-rs/vk_generator/index.html)
## [Documentation](https://docs.rs/vk_generator/)

## Custom Generators
`vk_generator` supports the usage of custom generators, which can be implemented as traits on the
Expand Down

0 comments on commit b4f505f

Please sign in to comment.