Fixing no-redundancy CELT->SILK and CELT->hybrid transitions
[opus.git] / README
diff --git a/README b/README
index fe0bc42..9a06811 100644 (file)
--- a/README
+++ b/README
@@ -13,14 +13,14 @@ soundtracks, portable music players, jukeboxes, and other applications that
 have historically used high latency formats such as MP3, AAC, or Vorbis.
 
                     Opus is specified by IETF RFC 6716:
-                    http://tools.ietf.org/html/rfc6716
+                    https://tools.ietf.org/html/rfc6716
 
   The Opus format and this implementation of it are subject to the royalty-
 free patent and copyright licenses specified in the file COPYING.
 
 This package implements a shared library for encoding and decoding raw Opus
 bitstreams. Raw Opus bitstreams should be used over RTP according to
- http://tools.ietf.org/html/draft-spittka-payload-rtp-opus
+ https://tools.ietf.org/html/rfc7587
 
 The package also includes a number of test  tools used for testing the
 correct operation of the library. The bitstreams read/written by these
@@ -29,7 +29,7 @@ additional debugging data and cannot support seeking.
 
 Opus stored in files should use the Ogg encapsulation for Opus which is
 described at:
- http://wiki.xiph.org/OggOpus
+ https://wiki.xiph.org/OggOpus
 
 An opus-tools package is available which provides encoding and decoding of
 Ogg encapsulated Opus files and includes a number of useful features.
@@ -37,27 +37,49 @@ Ogg encapsulated Opus files and includes a number of useful features.
 Opus-tools can be found at:
  https://git.xiph.org/?p=opus-tools.git
 or on the main Opus website:
- http://opus-codec.org/
+ https://opus-codec.org/
 
 == Compiling libopus ==
 
 To build from a distribution tarball, you only need to do the following:
 
-% ./configure
-% make
+    % ./configure
+    % make
 
 To build from the git repository, the following steps are necessary:
 
+0) Set up a development environment:
+
+On an Ubuntu or Debian family Linux distribution:
+
+    % sudo apt-get install git autoconf automake libtool gcc make
+
+On a Fedora/Redhat based Linux:
+
+    % sudo dnf install git autoconf automake libtool gcc make
+
+Or for older Redhat/Centos Linux releases:
+
+    % sudo yum install git autoconf automake libtool gcc make
+
+On Apple macOS, install Xcode and brew.sh, then in the Terminal enter:
+
+    % brew install autoconf automake libtool
+
 1) Clone the repository:
 
-% git clone git://git.opus-codec.org/opus.git
-% cd opus
+    % git clone https://git.xiph.org/opus.git
+    % cd opus
 
 2) Compiling the source
 
-% ./autogen.sh
-% ./configure
-% make
+    % ./autogen.sh
+    % ./configure
+    % make
+
+3) Install the codec libraries (optional)
+
+    % sudo make install
 
 Once you have compiled the codec, there will be a opus_demo executable
 in the top directory.
@@ -98,17 +120,18 @@ which SHOULD be run after compiling the package especially the first
 time it is run on a new platform.
 
 To run the integrated tests:
-% make check
+
+    % make check
 
 There is also collection of standard test vectors which are not
 included in this package for size reasons but can be obtained from:
-http://opus-codec.org/testvectors/opus_testvectors-draft11.tar.gz
+https://opus-codec.org/testvectors/opus_testvectors.tar.gz
 
 To run compare the code to these test vectors:
 
-% curl -O http://opus-codec.org/testvectors/opus_testvectors-draft11.tar.gz
-% tar -zxf opus_testvectors-draft11.tar.gz
-% ./tests/run_vectors.sh ./ opus_testvectors 48000
+    % curl -OL https://opus-codec.org/testvectors/opus_testvectors.tar.gz
+    % tar -zxf opus_testvectors.tar.gz
+    % ./tests/run_vectors.sh ./ opus_testvectors 48000
 
 == Portability notes ==