updates README now that we don't need Compat master [ci skip]

This commit is contained in:
Spencer Russell 2016-08-22 12:04:19 -04:00
parent 1e4bfaff06
commit b6f59a1e9d

View file

@ -3,8 +3,6 @@ PortAudio.jl
PortAudio.jl is a wrapper for [libportaudio](http://www.portaudio.com/), which gives cross-platform access to audio devices. It is compatible with the types defined in [SampledSignals.jl](https://github.com/JuliaAudio/SampledSignals.jl). It provides a `PortAudioStream` type, which can be read from and written to.
#### NOTE: This package currently requires the master branch of the `Compat`, `SampledSignals` and `RingBuffers` packages. Use `Pkg.checkout` to checkout the master.
## Opening a stream
The easiest way to open a source or sink is with the default `PortAudioStream()` constructor, which will open a 2-in, 2-out stream to your system's default device(s). The constructor can also take the input and output channel counts as positional arguments, or a variety of other keyword arguments.