Skip to content

Commit 8fd0337

Browse files
authored
Merge pull request #693 from PetrGlad/minimal-requirements-doc
Specify minimal hardware requirements
2 parents d93b1f3 + a1a5b75 commit 8fd0337

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,12 @@ See [the docs](https://docs.rs/rodio/latest/rodio/#alternative-decoder-backends)
2424

2525
We are currently making large improvements to rodio. This does mean the updated examples do not work with the current crates.io release. You will have to look at the examples from commit `f1eaaa4a`. They are available [on github](https://github.com/RustAudio/rodio/tree/f1eaaa4a6346933fc8a58d5fd1ace170946b3a94/examples).
2626

27+
## Requirements
28+
29+
Rodio playback works in environments supported by [cpal](https://github.com/RustAudio/cpal) library.
30+
31+
The CPU of the target system should have hardware support for 32-bit floating point (`f32`), and atomic operations that are at least 32 bit wide. Without these the CPU may not be fast enough to keep up with real-time.
32+
2733
## Dependencies (Linux only)
2834

2935
Rodio uses `cpal` library to send audio to the OS for playback. ALSA development files are needed to build `cpal` on Linux. These are provided as part of the `libasound2-dev` package on Debian and Ubuntu distributions and `alsa-lib-devel` on Fedora.

0 commit comments

Comments
 (0)