Added license and README

Cargo.toml

@@ -2,11 +2,10 @@
 name = "aftermath-rs"
 version = "0.1.0"
 edition = "2021"
-
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
-[dependencies]
-
+description = "Rust bindings for NVIDIA Aftermath, targeting Vulkan applications"
+license = "MIT"
+repository = "https://github.com/dust-engine/aftermath-rs"
+keywords = ["vulkan", "nvidia", "aftermath", "gpu", "ffi"]
 
 [build-dependencies]
 sysreq = "0"

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Zhixing Zhang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,41 @@
+# Aftermath-rs
+Rust bindings for the NVIDIA Aftermath SDK, targeting Vulkan applications.
+
+This crate helps you to obtain NVIDIA Aftermath GPU dump files after a device lost event.
+
+Supports both Windows and Linux. Closed-source binaries are automatically downloaded and statically linked.
+
+
+## Usage
+```rs
+extern crate aftermath_rs as aftermath;
+use ash::vk;
+
+struct Delegate;
+impl aftermath::AftermathDelegate for Delegate {
+    fn dumped(&mut self, dump_data: &[u8]) {
+        // Write `dump_data` to file, or send to telemetry server
+    }
+    fn shader_debug_info(&mut self, data: &[u8]) {
+    }
+
+    fn description(&mut self, describe: &mut aftermath::DescriptionBuilder) {
+    }
+}
+
+let _guard = aftermath::Aftermath::new(Delegate);
+
+fn handle_error(error: vk::Result) -> vk::Result {
+    let status = aftermath::Status::wait_for_status(Some(std::time::Duration::from_secs(5)));
+    if status != aftermath::Status::Finished {
+        panic!("Unexpected crash dump status: {:?}", status);
+    }
+    std::process::exit(1);
+}
+
+// Make Vulkan API Calls
+device.queue_submit(..)
+    .map_err(handle_error)
+    .unwrap();
+
+```