From: Hraban Luyat Date: Sun, 5 Jul 2015 11:47:14 +0000 (+0100) Subject: Update README X-Git-Tag: v2.0.0~108 X-Git-Url: http://www.git.stargrave.org/?a=commitdiff_plain;h=b1fdd1484653c99bff85a31ecc5e93a3b6cac45a;p=go-opus.git Update README --- diff --git a/README.md b/README.md index 28b430c..45edd81 100644 --- a/README.md +++ b/README.md @@ -3,22 +3,37 @@ This package provides Go bindings for the C library libopus, by xiph.org. The library, that is, not the bindings. The bindings are by me, Hraban. +### Build & installation + Installation is a bit of a mess right now but I'm working on simplifying it. Here's the summary: ```sh -git submodule init -git submodule update make -cp libopusbuild/lib/libopus.a . go build ``` -Now, here's the annoying part: the libopus.a file from the current directory -must always be present in every directory you use this this package from. So if -you create a new media player in Go and you include libopus, you must put that -.a file in your media player project directory. +Now, here's the annoying part: the libopus.a and libopusfile.a files from the +current directory must always be present in every directory you use this this +package from. So if you create a new media player in Go and you include libopus, +you must put those .a files in your media player project directory. It can be changed (https://groups.google.com/d/msg/golang-nuts/lF5skXi7OD4/SjwQbgju91QJ>) but -that's on my TODO list for now. +that's on my TODO list for now, under "not worth the trouble until a lot of +people actually use this." + +### License + +The licensing terms for the Go bindings are found in the LICENSE file. The +licensing terms for libopus and libopusfile are probably found in their +respective source directories, which are checked out as git submodules as part +of the build process. + +However, because libopus and liboupsfile are not (by source nor binaries) +included in this package, this package is (should be?) unaffected by their +licenses. + +Hraban + +hraban@0brg.net