From 0f31ebe4ecd6d355637505ae68c9e193a004168a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Fertig=20de=20Oliveira?= <160550426+AdreKiseque@users.noreply.github.com> Date: Wed, 21 Jan 2026 01:58:50 +0100 Subject: [PATCH] Improve wording and clarity in README.md Fixed some grammar and phrasing in the ReadMe. --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index befd1e9..a475f0a 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Crates.io](https://img.shields.io/crates/v/minifb.svg)](https://crates.io/crates/minifb) [![Documentation](https://docs.rs/minifb/badge.svg)](https://docs.rs/minifb) -minifb is a cross platform library written in [Rust](https://www.rust-lang.org) and that makes it easy to setup a window and to (optional) display a 32-bit pixel buffer. It also makes it easy to get input from keyboard and mouse. Notice that minifb is primary designed for prototyping and may not include all the features found in full window handling libraries. +minifb is a cross platform library written in [Rust](https://www.rust-lang.org) that makes it easy to set up a window and to (optionally) display a 32-bit pixel buffer. It also makes it easy to get input from keyboard and mouse. Note that minifb is primarily designed for prototyping and may not include all the features found in full window handling libraries. An example is the best way to show how it works: [Changelog](https://github.com/emoon/rust_minifb/blob/master/CHANGELOG.md) @@ -56,13 +56,14 @@ fn main() { Status ------ -Currently macOS, Linux and Windows (64-bit and 32-bit) are the current supported platforms. X11 (Linux/FreeBSD/etc) support has been tested on Ubuntu (x64). Linux Wayland support is also available. Bug report(s) for other OSes/CPUs are welcome! -Notice: That after 0.13 Redox hasn't been updated and some work is required to get that working again. PR are welcome. +Current supported platforms include macOS, Linux and Windows (64-bit and 32-bit). X11 (Linux/FreeBSD/etc) support has been tested on Ubuntu (x64). Linux Wayland support is also available. Bug reports for other OSes/CPUs are welcome! + +Notice: After 0.13, Redox hasn't been updated and some work is required to get it working again. PRs are welcome. Build instructions ------------------ -On Linux you may need to install these dependencies first: +On Linux, you may need to install these dependencies first: ``` sudo apt install libxkbcommon-dev libwayland-cursor0 libwayland-dev