Update version and copyright for the 1.3.7 release.

[platform/upstream/libvorbis.git] / README.md

diff --git a/README.md b/README.md
index 1028b2a..30c88d3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,8 @@
 # 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/)
+[![GitLab Build Status](https://gitlab.xiph.org/xiph/vorbis/badges/master/pipeline.svg)](https://gitlab.xiph.org/xiph/vorbis/-/pipelines)
+[![Travis Build Status](https://travis-ci.org/xiph/vorbis.svg?branch=master)](https://travis-ci.org/xiph/vorbis)
+[![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/github/xiph/vorbis?branch=master&svg=true)](https://ci.appveyor.com/project/rillian/vorbis)
 
 Vorbis is a general purpose audio and music encoding format
 contemporary to MPEG-4's AAC and TwinVQ, the next generation beyond
@@ -9,20 +10,20 @@ MPEG audio layer 3. Unlike the MPEG sponsored formats (and other
 proprietary formats such as RealAudio G2 and Windows' flavor of the
 month), the Vorbis CODEC specification belongs to the public domain.
 All the technical details are published and documented, and any
-software entity may make full use of the format without license 
+software entity may make full use of the format without license
 fee, royalty or patent concerns.
 
 This package contains:
 
 - libvorbis, a BSD-style license software implementation of
-  the Vorbis specification by the Xiph.Org Foundation 
-  (http://www.xiph.org/) 
+  the Vorbis specification by the Xiph.Org Foundation
+  (https://xiph.org/)
 
 - 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,
-  programmatic encoding setup interface 
+  programmatic encoding setup interface
 
 - example code making use of libogg, libvorbis, libvorbisfile and
   libvorbisenc
@@ -57,19 +58,17 @@ Directory:
 
 ## Contact ##
 
-The Ogg homepage is located at 'http://www.xiph.org/ogg/'.
-Vorbis's homepage is located at 'http://www.xiph.org/vorbis/'.
+The Ogg homepage is located at 'https://xiph.org/ogg/'.
+Vorbis's homepage is located at 'https://xiph.org/vorbis/'.
 Up to date technical documents, contact information, source code and
 pre-built utilities may be found there.
 
-The user website for Ogg Vorbis software and audio is http://vorbis.com/
-
 ## Building ##
 
 #### Building from master ####
 
-Development source is under git revision control at 
-https://git.xiph.org/vorbis.git. You will also need the 
+Development source is under git revision control at
+https://gitlab.xiph.org/xiph/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.
@@ -104,6 +103,39 @@ after normal configuring:
     make dist
     rpm -ta libvorbis-<version>.tar.gz
 
+## Building with CMake ##
+
+Ogg supports building using [CMake](https://cmake.org/). CMake is a meta build system that generates native projects for each platform.
+To generate projects just run cmake replacing `YOUR-PROJECT-GENERATOR` with a proper generator from a list [here](https://cmake.org/cmake/help/latest/manual/cmake-generators.7.html):
+
+    cmake -G YOUR-PROJECT-GENERATOR .
+
+Note that by default cmake generates projects that will build static libraries.
+To generate projects that will build dynamic library use `BUILD_SHARED_LIBS` option like this:
+
+    cmake -G YOUR-PROJECT-GENERATOR -DBUILD_SHARED_LIBS=1 .
+
+After projects are generated use them as usual
+
+#### Building on Windows ####
+
+Use proper generator for your Visual Studio version like:
+
+    cmake -G "Visual Studio 12 2013" .
+
+#### Building on Mac OS X ####
+
+Use Xcode generator. To build framework run:
+
+    cmake -G Xcode -DBUILD_FRAMEWORK=1 .
+
+#### Building on Linux ####
+
+Use Makefile generator which is default one.
+
+    cmake .
+    make
+
 ## License ##
 
 THIS FILE IS PART OF THE OggVorbis SOFTWARE CODEC SOURCE CODE.
@@ -111,8 +143,5 @@ 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/
-
-
-
+THE OggVorbis SOURCE CODE IS COPYRIGHT (C) 1994-2020
+by the Xiph.Org Foundation https://xiph.org/