Skip to content

Commit 8f96cf9

Browse files
committed
README.md: add table of contents
By now, our README has grown quite long, and at multiple occassions people were unable to find the correct spot in our documentation. Add a table of contents to at least present an overview over all topics that are being covered by our README.
1 parent 771dfd1 commit 8f96cf9

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,27 @@ with any kind of software without having to release its source code.
2727
Additionally, the example code has been released to the public domain (see the
2828
[separate license](examples/COPYING) for more information).
2929

30+
Table of Contents
31+
=================
32+
33+
* [Quick Start](#quick-start)
34+
* [Getting Help](#getting-help)
35+
* [What It Can Do](#what-it-can-do)
36+
* [Optional dependencies](#optional-dependencies)
37+
* [Initialization](#initialization)
38+
* [Threading](#threading)
39+
* [Conventions](#conventions)
40+
* [Building libgit2 - Using CMake](#building-libgit2---using-cmake)
41+
* [Building](#building)
42+
* [Installation](#installation)
43+
* [Advanced Usage](#advanced-usage)
44+
* [Compiler and linker options](#compiler-and-linker-options)
45+
* [MacOS X](#macos-x)
46+
* [Android](#android)
47+
* [Language Bindings](#language-bindings)
48+
* [How Can I Contribute?](#how-can-i-contribute)
49+
* [License](#license)
50+
3051
Quick Start
3152
===========
3253

0 commit comments

Comments
 (0)