From 4311b27193777d8365e4ada2a664b6caa5194808 Mon Sep 17 00:00:00 2001 From: David Johnson Date: Wed, 19 Jan 2022 21:57:09 -0600 Subject: [PATCH] Modified Cargo.toml and README.md to prepare for publication to crates.io --- Cargo.toml | 9 ++++++++- README.md | 7 ++++--- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 03b4e1a..a49c79b 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,10 +1,17 @@ [package] name = "softbuffer" -version = "0.0.1" +version = "0.1.0" edition = "2021" authors = ["David Johnson "] license = "MIT OR Apache-2.0" description = "Softbuffer integrates with the raw-window-handle crate to allow writing to a window in a cross-platform way while using the very high quality dedicated window management libraries that are available in the Rust ecosystem." +documentation = "https://docs.rs/softbuffer" +readme = "README.md" +homepage = "https://github.com/john01dav/softbuffer" +repository = "https://github.com/john01dav/softbuffer" +keywords = ["framebuffer"] +categories = ["game-development", "graphics", "gui", "multimedia", "rendering"] +exclude = ["examples"] [dependencies] thiserror = "1.0.30" diff --git a/README.md b/README.md index bebd703..4c24611 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ libraries that are available in the Rust ecosystem. What about [pixels](https://crates.io/crates/pixels)? Pixels accomplishes a very similar goal to softbuffer, however there are two key differences. Pixels provides some capacity for GPU-accelerated post-processing of what is displayed, while Softbuffer does not. Due to not having this post-processing, Softbuffer does not rely on the GPU or -hardware accelerated graphcis stack in any way, and is thus more portable to installations that do not have access to +hardware accelerated graphics stack in any way, and is thus more portable to installations that do not have access to hardware acceleration (e.g. VMs, older computers, computers with misconfigured drivers). Softbuffer should be used over pixels when its GPU-accelerated post-processing effects are not needed. @@ -28,8 +28,9 @@ from the minifb library to do platform-specific work. Platform support: == -Some, but not all, platforms supported in [raw-window-handle]() are supported by Softbuffer. Pull requests are welcome -to add new platforms! +Some, but not all, platforms supported in [raw-window-handle](https://crates.io/crates/raw-window-handle) are supported +by Softbuffer. Pull requests are welcome to add new platforms! **Nonetheless, all major desktop platforms that winit uses +on desktop are supported.** For now, the priority for new platforms is: 1) to have at least one platform on each OS working (e.g. one of Win32 or WinRT, or one of Xlib, Xcb, and Wayland) and