Skip to content

Commit

Permalink
README: Add more information about platform support and requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
crumblingstatue committed Oct 12, 2024
1 parent 417e987 commit 0e68eae
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,24 @@ rust-sfml ![Build Status](https://github.com/jeremyletang/rust-sfml/actions/work

Rust bindings for [SFML](http://www.sfml-dev.org), the Simple and Fast Multimedia Library.

Requirements
Platform support
================

| | |
|-------------|---------------------------------------------------|
| 🐧 Linux | ✅ Most tested |
| 🪟 Windows | ⚠️ Rarely tested. Looking for testers/maintainers! |
| 🍎 Mac OS X | ❌ Untested. Looking for testers/maintainers! |

Prerequisites
=============

- Linux, Windows, or OS X
- Rust 1.81 or later
- [CMake](https://cmake.org/), and a C++ compiler for building SFML
- [CMake](https://cmake.org/), and a C++ toolchain for building SFML
- 🐧 On Linux, you need the following dependencies installed:
- Window module: `libGL libX11 libXcursor libXrandr`
- Graphics module: `libfreetype`
- Audio module: `libopenal libvorbisenc libvorbisfile libvorbis`

Documentation
=============
Expand Down

0 comments on commit 0e68eae

Please sign in to comment.