Skip to content
This repository was archived by the owner on Jan 19, 2021. It is now read-only.

Commit a7e48aa

Browse files
authored
Update README.md
1 parent 46e4c6f commit a7e48aa

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,27 @@
88
<img src="img/init_add_commit.png"/>
99
</p>
1010

11+
## Table of Contents
12+
13+
* [Build and Integration](#build-and-integration)
14+
* [Sample Programs](#sample-programs)
15+
* [Initialize a new repository (`git init`)](#initialize-a-new-repository-git-init)
16+
* [Clone a repository and checkout specific branch (`git clone --branch`)](#clone-a-repository-and-checkout-specific-branch-git-clone---branch)
17+
* [Open an existing repository](#open-an-existing-repository)
18+
* [Add and Commit a File (`git add`, `git commit`)](#add-and-commit-a-file-git-add-git-commit)
19+
* [Walk Repository Tree (`git ls-tree`)](#walk-repository-tree-git-ls-tree)
20+
* [Print Branches (`git branch`)](#print-branches-git-branch)
21+
* [Print Commits (`git log`)](#print-commits-git-log)
22+
* [Print Repository Tags (`git tag`)](#print-commits-git-log)
23+
* [Inspect Repository Objects (`git cat-file (-s|-p|-t)`)](#inspect-repository-objects-git-cat-file)
24+
* [Design Notes](#design-notes)
25+
* [Interoperability with libgit2](#interoperability-with-libgit2)
26+
* [Ownership and Memory Management](#ownership-and-memory-management)
27+
* [Error Handling](#error-handling)
28+
* [Contributing](#contributing)
29+
* [License](#license)
30+
* [API Coverage](#api-coverage)
31+
1132
## Build and Integration
1233

1334
Run the following commands to build `cppgit2`.
@@ -702,7 +723,7 @@ git_exception() {
702723
virtual const char *what() const throw() { return message_; }
703724
```
704725

705-
## Contributions
726+
## Contributing
706727

707728
`cppgit2` is in active development. `libgit2` is constantly evolving with over 750 functions in its public API. A good portion of this is covered in `cppgit2` (See [API Coverage](#api-coverage)). However, there is much room for improvement - in terms of code quality, tests, and samples.
708729

0 commit comments

Comments
 (0)