Skip to content

Improve wording and clarity in README.md #396

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
emoon merged 1 commit into from
Jan 21, 2026
Merged

Improve wording and clarity in README.md #396

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down
Loading