Commit 4fea4923 authored by stopiccot's avatar stopiccot Committed by Ralph Giles

Switch README to markdown.

Signed-off-by: Ralph Giles's avatarRalph Giles <giles@thaumas.net>
parent 572db8fa
********************************************************************
* *
* THIS FILE IS PART OF THE OggVorbis SOFTWARE CODEC SOURCE CODE. *
* USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS *
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
* THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2015 *
* by the Xiph.org Foundation, http://www.xiph.org/ *
* *
********************************************************************
# Vorbis
[![Travis Build Status](https://travis-ci.org/xiph/vorbis.png?branch=master)](https://travis-ci.org/xiph/vorbis)
[![Jenkins Build Status](https://mf4.xiph.org/jenkins/job/libvorbis/badge/icon)](https://mf4.xiph.org/jenkins/job/libvorbis/)
Vorbis is a general purpose audio and music encoding format
contemporary to MPEG-4's AAC and TwinVQ, the next generation beyond
......@@ -21,20 +14,20 @@ fee, royalty or patent concerns.
This package contains:
* libvorbis, a BSD-style license software implementation of
- libvorbis, a BSD-style license software implementation of
the Vorbis specification by the Xiph.Org Foundation
(http://www.xiph.org/)
* libvorbisfile, a BSD-style license convenience library
- libvorbisfile, a BSD-style license convenience library
built on Vorbis designed to simplify common uses
* libvorbisenc, a BSD-style license library that provides a simple,
- libvorbisenc, a BSD-style license library that provides a simple,
programmatic encoding setup interface
* example code making use of libogg, libvorbis, libvorbisfile and
- example code making use of libogg, libvorbis, libvorbisfile and
libvorbisenc
WHAT'S HERE:
## What's here ##
This source distribution includes libvorbis and an example
encoder/player to demonstrate use of libvorbis as well as
......@@ -46,26 +39,23 @@ package.
Directory:
./lib The source for the libraries, a BSD-license implementation
of the public domain Ogg Vorbis audio encoding format.
- `lib` The source for the libraries, a BSD-license implementation of the public domain Ogg Vorbis audio encoding format.
./include Library API headers
- `include` Library API headers
./debian Rules/spec files for building Debian .deb packages
- `debian` Rules/spec files for building Debian .deb packages
./doc Vorbis documentation
- `doc` Vorbis documentation
./examples Example code illustrating programmatic use of libvorbis,
libvorbisfile and libvorbisenc
- `examples` Example code illustrating programmatic use of libvorbis, libvorbisfile and libvorbisenc
./macosx Project files for MacOS X.
- `macosx` Project files for MacOS X.
./win32 Win32 projects files and build automation
- `win32` Win32 projects files and build automation
./vq Internal utilities for training/building new LSP/residue
and auxiliary codebooks.
- `vq` Internal utilities for training/building new LSP/residue and auxiliary codebooks.
CONTACT:
## Contact ##
The Ogg homepage is located at 'http://www.xiph.org/ogg/'.
Vorbis's homepage is located at 'http://www.xiph.org/vorbis/'.
......@@ -74,21 +64,23 @@ pre-built utilities may be found there.
The user website for Ogg Vorbis software and audio is http://vorbis.com/
BUILDING FROM TRUNK:
## Building ##
#### Building from master ####
Development source is under subversion revision control at
https://svn.xiph.org/trunk/vorbis/. You will also need the
Development source is under git revision control at
https://git.xiph.org/vorbis.git. You will also need the
newest versions of autoconf, automake, libtool and pkg-config in
order to compile Vorbis from development source. A configure script
is provided for you in the source tarball distributions.
[update or checkout latest source]
./autogen.sh
make
./autogen.sh
./configure
make
and as root if desired:
make install
make install
This will install the Vorbis libraries (static and shared) into
/usr/local/lib, includes into /usr/local/include and API manpages
......@@ -96,20 +88,31 @@ This will install the Vorbis libraries (static and shared) into
Documentation building requires xsltproc and pdfxmltex.
BUILDING FROM TARBALL DISTRIBUTIONS:
#### Building from tarball distributions ####
./configure
make
./configure
make
and optionally (as root):
make install
BUILDING RPMS:
make install
#### Building RPM packages ####
after normal configuring:
make dist
rpm -ta libvorbis-<version>.tar.gz
make dist
rpm -ta libvorbis-<version>.tar.gz
## License ##
THIS FILE IS PART OF THE OggVorbis SOFTWARE CODEC SOURCE CODE.
USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS
GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE
IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING.
THE OggVorbis SOURCE CODE IS COPYRIGHT (C) 1994-2015
by the Xiph.Org Foundation https://www.xiph.org/
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment