Skip to content

Commit c62fc7a

Browse files
committed
removes master warning from README
1 parent 9756223 commit c62fc7a

File tree

2 files changed

+1
-2
lines changed

2 files changed

+1
-2
lines changed

Diff for: .gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,6 @@
22
*.so
33
*.o
44
deps/deps.jl
5+
deps/build.log
56
*.cov
67
coverage

Diff for: README.md

-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ LibSndFile.jl
44
[![Build status](https://ci.appveyor.com/api/projects/status/1wdo413vf375i1vr/branch/master?svg=true)](https://ci.appveyor.com/project/ssfrr/libsndfile-jl/branch/master)
55
[![codecov.io](https://codecov.io/github/JuliaAudio/LibSndFile.jl/coverage.svg?branch=master)](https://codecov.io/github/JuliaAudio/LibSndFile.jl?branch=master)
66

7-
**Dev Note: The master branch of LibSndFile currently requires the master branch of SampledSignals. Once things stabilize across the JuliaAudio ecosystem we'll tag 1.0-compatible releases of all of the packages.**
8-
97
LibSndFile.jl is a wrapper for [libsndfile](http://www.mega-nerd.com/libsndfile/), and supports a wide variety of file and sample formats. The package uses the [FileIO](https://github.com/JuliaIO/FileIO.jl) `load` and `save` interface to automatically figure out the file type of the file to be opened, and the file contents are represented as a `SampleBuf`. For streaming I/O we support FileIO's `loadstreaming` and `savestreaming` functions as well. The results are represented as `SampleSource` (for reading), or `SampleSink` (for writing) subtypes. These buffer and stream types are defined in the [SampledSignals](https://github.com/JuliaAudio/SampledSignals.jl) package.
108

119
Note that the `load`/`save`/etc. interface is exported from `FileIO`, and `LibSndFile` registers itself when the loaded, so you should bring in both packages. LibSndFile doesn't export any of its own names.

0 commit comments

Comments
 (0)