From: Hraban Luyat <hraban@0brg.net>
Date: Mon, 9 Mar 2015 12:29:06 +0000 (+0000)
Subject: Short readme with build instructions
X-Git-Tag: v2.0.0~119
X-Git-Url: http://www.git.stargrave.org/?a=commitdiff_plain;h=644101374594bfd1c8e5376f2e86cd1e7be32245;p=go-opus.git

Short readme with build instructions
---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4fc6a66
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+## opus, by xiph.org
+
+This package provides Go bindings for the C library libopus, by xiph.org.
+
+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.
+
+It can be changed
+(https://groups.google.com/d/msg/golang-nuts/lF5skXi7OD4/SjwQbgju91QJ>) but
+that's on my TODO list for now.