Skip to content

Commit 4311b27

Browse files
committed
Modified Cargo.toml and README.md to prepare for publication to crates.io
1 parent d8087a6 commit 4311b27

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

Cargo.toml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
11
[package]
22
name = "softbuffer"
3-
version = "0.0.1"
3+
version = "0.1.0"
44
edition = "2021"
55
authors = ["David Johnson <[email protected]>"]
66
license = "MIT OR Apache-2.0"
77
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."
8+
documentation = "https://docs.rs/softbuffer"
9+
readme = "README.md"
10+
homepage = "https://github.com/john01dav/softbuffer"
11+
repository = "https://github.com/john01dav/softbuffer"
12+
keywords = ["framebuffer"]
13+
categories = ["game-development", "graphics", "gui", "multimedia", "rendering"]
14+
exclude = ["examples"]
815

916
[dependencies]
1017
thiserror = "1.0.30"

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ libraries that are available in the Rust ecosystem.
1515
What about [pixels](https://crates.io/crates/pixels)? Pixels accomplishes a very similar goal to softbuffer,
1616
however there are two key differences. Pixels provides some capacity for GPU-accelerated post-processing of what is
1717
displayed, while Softbuffer does not. Due to not having this post-processing, Softbuffer does not rely on the GPU or
18-
hardware accelerated graphcis stack in any way, and is thus more portable to installations that do not have access to
18+
hardware accelerated graphics stack in any way, and is thus more portable to installations that do not have access to
1919
hardware acceleration (e.g. VMs, older computers, computers with misconfigured drivers). Softbuffer should be used over
2020
pixels when its GPU-accelerated post-processing effects are not needed.
2121

@@ -28,8 +28,9 @@ from the minifb library to do platform-specific work.
2828

2929
Platform support:
3030
==
31-
Some, but not all, platforms supported in [raw-window-handle]() are supported by Softbuffer. Pull requests are welcome
32-
to add new platforms!
31+
Some, but not all, platforms supported in [raw-window-handle](https://crates.io/crates/raw-window-handle) are supported
32+
by Softbuffer. Pull requests are welcome to add new platforms! **Nonetheless, all major desktop platforms that winit uses
33+
on desktop are supported.**
3334

3435
For now, the priority for new platforms is:
3536
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

0 commit comments

Comments
 (0)