ref: 1eaa67c0dce1f642af872cc26b7ff4b057a55bfb
parent: badd1e56c64a4af8138c542c2a0507f3c8cca1d9
author: Ralph Giles <giles@thaumas.net>
date: Wed May 10 06:46:22 EDT 2017
Indent commands in the README. Makes things a little easier to read. Signed-off-by: Gian-Carlo Pascutto <gcp@sjeng.org>
--- a/README
+++ b/README
@@ -43,8 +43,8 @@
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:
@@ -52,34 +52,34 @@
On an Ubuntu or Debian family Linux distribution:
-% sudo apt-get install git autoconf automake libtool gcc make
+ % 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
+ % 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
+ % 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
+ % brew install autoconf automake libtool
1) Clone the repository:
-% git clone https://git.xiph.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
+ % sudo make install
Once you have compiled the codec, there will be a opus_demo executable
in the top directory.
@@ -120,8 +120,9 @@
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:
https://opus-codec.org/testvectors/opus_testvectors.tar.gz
@@ -128,9 +129,9 @@
To run compare the code to these test vectors:
-% curl -O https://opus-codec.org/testvectors/opus_testvectors.tar.gz
-% tar -zxf opus_testvectors.tar.gz
-% ./tests/run_vectors.sh ./ opus_testvectors 48000
+ % curl -O https://opus-codec.org/testvectors/opus_testvectors.tar.gz
+ % tar -zxf opus_testvectors.tar.gz
+ % ./tests/run_vectors.sh ./ opus_testvectors 48000
== Portability notes ==