From 9d23910d059ca840079e10dadc28385109d5544a Mon Sep 17 00:00:00 2001 From: Graham Wihlidal Date: Sun, 26 Aug 2018 21:17:14 +0200 Subject: [PATCH] Updated package metadata --- CHANGES.md | 5 ++++ CODE_OF_CONDUCT.md | 46 ++++++++++++++++++++++++++++++++++ Cargo.toml | 34 +++++++++++++++++++++++--- README.md | 61 ++++++++++++++++++++++++++++++++++++++++++++-- rustfmt.toml | 3 ++- 5 files changed, 143 insertions(+), 6 deletions(-) create mode 100644 CHANGES.md create mode 100644 CODE_OF_CONDUCT.md diff --git a/CHANGES.md b/CHANGES.md new file mode 100644 index 0000000..92dd5e3 --- /dev/null +++ b/CHANGES.md @@ -0,0 +1,5 @@ +# Changes + +## 0.1.0 (2018-08-26) + +* First release \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..1261331 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,46 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at fafhrd91@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ \ No newline at end of file diff --git a/Cargo.toml b/Cargo.toml index 380268d..db6da0a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,14 +3,42 @@ name = "vk-sync" version = "0.1.0" license = "MIT/Apache-2.0" authors = ["Graham Wihlidal "] +homepage = "https://github.com/gwihlidal/vk-sync-rs" repository = "https://github.com/gwihlidal/vk-sync-rs" +documentation = "https://docs.rs/vk-sync" +description = "Simplification of core Vulkan synchronization mechanisms such as pipeline barriers and events." +categories = ["api-bindings", "rendering", "rendering::engines", "rendering::graphics-api", ] +keywords = ["vulkan", "vk", "ash", "synchronization", "transition", "barrier", "event", "graphics", "3d", "compute", "gamedev"] +readme = "README.md" +exclude = [ + ".travis.yml", + ".gitignore", + "appveyor.yml" +] + +[badges] +travis-ci = { repository = "gwihlidal/vk-sync-rs" } +appveyor = { repository = "gwihlidal/vk-sync-rs" } +codecov = { repository = "gwihlidal/vk-sync-rs", branch = "master", service = "github" } +maintenance = { status = "actively-developed" } + +[lib] +name = "vk_sync" +path = "src/lib.rs" [dependencies] +ash = { version = "0.24.4", optional = true } [features] default = ["ash_bind"] ash_bind = ["ash"] -[dependencies.ash] -version = "0.24.4" -optional = true \ No newline at end of file +[profile.release] +lto = true +opt-level = 3 +codegen-units = 1 + +[workspace] +members = [ + "./", +] \ No newline at end of file diff --git a/README.md b/README.md index edf8d19..8a22408 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,59 @@ -# vk-sync-rs -Simplified Vulkan synchronization logic, written in rust +vk-sync +======== + +[![vk-sync on travis-ci.com](https://travis-ci.com/gwihlidal/vk-sync-rs.svg?branch=master)](https://travis-ci.com/gwihlidal/vk-sync-rs) +[![vk-sync on appveyor.com](https://ci.appveyor.com/api/projects/status/9so5ab02cqyba843/branch/master?svg=true)](https://ci.appveyor.com/project/gwihlidal/vk-sync-rs/branch/master) +[![Latest version](https://img.shields.io/crates/v/vk-sync.svg)](https://crates.io/crates/vk-sync) +[![Documentation](https://docs.rs/vk-sync/badge.svg)](https://docs.rs/vk-sync) +[![](https://tokei.rs/b1/github/gwihlidal/vk-sync-rs)](https://github.com/gwihlidal/vk-sync-rs) + +Simplified Vulkan synchronization logic, written in rust. + +- [Documentation](https://docs.rs/vk-sync) +- [Release Notes](https://github.com/gwihlidal/vk-sync-rs/releases) + +## Overview + +In an effort to make Vulkan synchronization more accessible, this library provides a simplification of core synchronization mechanisms such as pipeline barriers and events. + +Rather than the complex maze of enums and bit flags in Vulkan - many combinations of which are invalid or nonsensical - this library collapses this to a much shorter list of ~40 distinct usage types, and a couple of options for handling image layouts. + +Additionally, these usage types provide an easier mapping to other graphics APIs like DirectX 12. + +Use of other synchronization mechanisms such as semaphores, fences and render passes are not addressed in this library at present. + +## Usage + +Add this to your `Cargo.toml`: + +```toml +[dependencies] +vk-sync = "0.1.0" +``` + +and this to your crate root: + +```rust +extern crate vk_sync; +``` + +## License + +Licensed under either of + + * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) + * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) + +at your option. + +## Contribution + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in this crate by you, as defined in the Apache-2.0 license, shall +be dual licensed as above, without any additional terms or conditions. + +## Code of Conduct + +Contribution to the vk-sync crate is organized under the terms of the +Contributor Covenant, the maintainer of vk-sync, @gwihlidal, promises to +intervene to uphold that code of conduct. \ No newline at end of file diff --git a/rustfmt.toml b/rustfmt.toml index 18d655e..4a18caa 100644 --- a/rustfmt.toml +++ b/rustfmt.toml @@ -1 +1,2 @@ -hard_tabs = true \ No newline at end of file +hard_tabs = true +reorder_imports = true \ No newline at end of file