From 53ce0f4555ec75119ede3b4f91da41f98cd2fe97 Mon Sep 17 00:00:00 2001 From: Peter Dave Hello Date: Wed, 14 Mar 2018 17:58:30 +0800 Subject: [PATCH] Add Table of Contents in README --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 8f304bf9..e48f277d 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,28 @@ http://ultravideo.cs.tut.fi/#encoder for more information. - Linux/Mac [![Build Status](https://travis-ci.org/ultravideo/kvazaar.svg?branch=master)](https://travis-ci.org/ultravideo/kvazaar) - Windows [![Build status](https://ci.appveyor.com/api/projects/status/88sg1h25lp0k71pu?svg=true)](https://ci.appveyor.com/project/Ultravideo/kvazaar) +## Table of Contents + +- [Using Kvazaar](#using-kvazaar) + - [Example:](#example) + - [Parameters](#parameters) + - [LP-GOP syntax](#lp-gop-syntax) +- [Presets](#presets) +- [Kvazaar library](#kvazaar-library) +- [Compiling Kvazaar](#compiling-kvazaar) + - [Required libraries](#required-libraries) + - [Autotools](#autotools) + - [OS X](#os-x) + - [Visual Studio](#visual-studio) + - [Docker](#docker) + - [Visualization (Windows only)](#visualization-windows-only) +- [Contributing to Kvazaar](#contributing-to-kvazaar) + - [Code documentation](#code-documentation) + - [For version control we try to follow these conventions:](#for-version-control-we-try-to-follow-these-conventions) + - [Testing](#testing) + - [Unit tests](#unit-tests) + - [Code style](#code-style) + ## Using Kvazaar ### Example: