Indent commands in the README.

Makes things a little easier to read.

Signed-off-by: Gian-Carlo Pascutto <gcp@sjeng.org>
This commit is contained in:
Ralph Giles 2017-05-10 10:46:22 -07:00
parent badd1e56c6
commit 1eaa67c0dc
No known key found for this signature in database
GPG key ID: 47000F7BB1441DEF

33
README
View file

@ -43,8 +43,8 @@ or on the main Opus website:
To build from a distribution tarball, you only need to do the following: To build from a distribution tarball, you only need to do the following:
% ./configure % ./configure
% make % make
To build from the git repository, the following steps are necessary: To build from the git repository, the following steps are necessary:
@ -52,34 +52,34 @@ To build from the git repository, the following steps are necessary:
On an Ubuntu or Debian family Linux distribution: 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: 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: 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: 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: 1) Clone the repository:
% git clone https://git.xiph.org/opus.git % git clone https://git.xiph.org/opus.git
% cd opus % cd opus
2) Compiling the source 2) Compiling the source
% ./autogen.sh % ./autogen.sh
% ./configure % ./configure
% make % make
3) Install the codec libraries (optional) 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 Once you have compiled the codec, there will be a opus_demo executable
in the top directory. in the top directory.
@ -120,7 +120,8 @@ which SHOULD be run after compiling the package especially the first
time it is run on a new platform. time it is run on a new platform.
To run the integrated tests: To run the integrated tests:
% make check
% make check
There is also collection of standard test vectors which are not There is also collection of standard test vectors which are not
included in this package for size reasons but can be obtained from: included in this package for size reasons but can be obtained from:
@ -128,9 +129,9 @@ https://opus-codec.org/testvectors/opus_testvectors.tar.gz
To run compare the code to these test vectors: To run compare the code to these test vectors:
% curl -O https://opus-codec.org/testvectors/opus_testvectors.tar.gz % curl -O https://opus-codec.org/testvectors/opus_testvectors.tar.gz
% tar -zxf opus_testvectors.tar.gz % tar -zxf opus_testvectors.tar.gz
% ./tests/run_vectors.sh ./ opus_testvectors 48000 % ./tests/run_vectors.sh ./ opus_testvectors 48000
== Portability notes == == Portability notes ==