Toplevel Makefile, some project info
authorJean-Marc Valin <jean-marc.valin@octasic.com>
Mon, 5 Jul 2010 18:55:02 +0000 (14:55 -0400)
committerJean-Marc Valin <jean-marc.valin@octasic.com>
Mon, 5 Jul 2010 18:55:02 +0000 (14:55 -0400)
AUTHORS [new file with mode: 0644]
COPYING [new file with mode: 0644]
Makefile
README

diff --git a/AUTHORS b/AUTHORS
new file mode 100644 (file)
index 0000000..48a298d
--- /dev/null
+++ b/AUTHORS
@@ -0,0 +1,3 @@
+Jean-Marc Valin (jean-marc.valin@octasic.com)
+Koen Vos (koen.vos@skype.net)
+Timothy Terriberry (tterribe@xiph.org)
diff --git a/COPYING b/COPYING
new file mode 100644 (file)
index 0000000..b5499c2
--- /dev/null
+++ b/COPYING
@@ -0,0 +1,30 @@
+Copyright 2001-2010 Xiph.Org, Skype, Jean-Marc Valin, 
+                    Timothy B. Terriberry, CSIRO, 
+                    and other contributors
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+- Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+
+- Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+- Neither the name of the Xiph.org Foundation nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
index eccea5a..22e9560 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -1,4 +1,5 @@
 all: celt silk
+       (cd src; make)
 
 celt:
        (cd celt; make)
diff --git a/README b/README
index b677cc6..43ccd54 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,20 @@
 This is a prototype codec and for now it doesn't do anything useful. To get
 the celt and silk submodules, you need to do:
 
-git submodule init
-git submodule update
+% git submodule init
+% git submodule update
+
+Compiling is currently tricky. You first need to configure the CELT directory:
+
+% cd celt
+% ./autogen.sh
+% ./configure --disable-shared
+% cd ..
+
+Then you can use the top-level Makefile by typing:
+
+% make
+
+If you're lucky, then everything works. Most likely there will be an error in
+one of the paths that are hardcoded into one of the makefiles. This should
+improve in the future.