summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPatrick Steinhardt <ps@pks.im>2018-03-22 09:13:18 +0000
committerPatrick Steinhardt <ps@pks.im>2018-05-30 11:11:07 +0200
commit8f96cf9aa55609b3408584d8daa032272203ea2c (patch)
treed6a481bda0bc6b36628632dbbd6a73620117ce76 /README.md
parent771dfd1dd1c27a4693dfdfea521c07e72f456b29 (diff)
downloadlibgit2-8f96cf9aa55609b3408584d8daa032272203ea2c.tar.gz
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.
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
index 9fe99d8d5..a6fbca24c 100644
--- a/README.md
+++ b/README.md
@@ -27,6 +27,27 @@ with any kind of software without having to release its source code.
Additionally, the example code has been released to the public domain (see the
[separate license](examples/COPYING) for more information).
+Table of Contents
+=================
+
+* [Quick Start](#quick-start)
+* [Getting Help](#getting-help)
+* [What It Can Do](#what-it-can-do)
+* [Optional dependencies](#optional-dependencies)
+* [Initialization](#initialization)
+* [Threading](#threading)
+* [Conventions](#conventions)
+* [Building libgit2 - Using CMake](#building-libgit2---using-cmake)
+ * [Building](#building)
+ * [Installation](#installation)
+ * [Advanced Usage](#advanced-usage)
+ * [Compiler and linker options](#compiler-and-linker-options)
+ * [MacOS X](#macos-x)
+ * [Android](#android)
+* [Language Bindings](#language-bindings)
+* [How Can I Contribute?](#how-can-i-contribute)
+* [License](#license)
+
Quick Start
===========