Skip to content

Commit fa23019

Browse files
committed
Suggest using CPAL instead of PortAudio
1 parent 095a617 commit fa23019

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,23 +11,24 @@ rust-portaudio
1111

1212
PortAudio is a free, cross-platform, open-source, audio I/O library.
1313

14-
**rust-portaudio** is still under development, so there may be bugs - please feel free to add an issue or even better, submit a PR!
15-
16-
To use **rust-portaudio** in your own project, add it to your Cargo.toml dependencies like so:
17-
18-
```toml
19-
[dependencies]
20-
portaudio = "X.Y.Z"
21-
```
14+
**rust-portaudio** is in maintenance mode. Consider using
15+
[CPAL](https://github.com/RustAudio/cpal) instead.
2216

2317

2418
# Installation
2519

26-
**rust-portaudio** will try to detect portaudio on your system and, failing that (or if given the `PORTAUDIO_ONLY_STATIC` environment variable on the build process), will download and build portaudio statically. If this fails please let us know! In the mean-time, you can manually [download and install PortAudio](http://www.portaudio.com/download.html) yourself.
27-
28-
On Mac OS X, you may need to install manually `portaudio` and `pkg-config` (using [brew](http://brew.sh/), run `brew install portaudio` and `brew install pkg-config`)
20+
**rust-portaudio** will try to detect portaudio on your system and, failing that
21+
(or if given the `PORTAUDIO_ONLY_STATIC` environment variable on the build
22+
process), will download and build portaudio statically. If this fails please let
23+
us know! In the mean-time, you can manually [download and install
24+
PortAudio](http://www.portaudio.com/download.html) yourself.
2925

30-
**rust-portaudio** is built using cargo, so just type `cargo build` at the root of the **rust-portaudio** repository.
26+
On Mac OS X, you may need to install manually `portaudio` and `pkg-config`
27+
(using [brew](http://brew.sh/), run `brew install portaudio` and `brew install
28+
pkg-config`)
3129

32-
You can build the tests and examples with `cargo test`, and the documentation with `cargo doc`.
30+
**rust-portaudio** is built using cargo, so just type `cargo build` at the root
31+
of the **rust-portaudio** repository.
3332

33+
You can build the tests and examples with `cargo test`, and the documentation
34+
with `cargo doc`.

0 commit comments

Comments
 (0)