|
8 | 8 | <img src="img/init_add_commit.png"/> |
9 | 9 | </p> |
10 | 10 |
|
| 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 | + |
11 | 32 | ## Build and Integration |
12 | 33 |
|
13 | 34 | Run the following commands to build `cppgit2`. |
@@ -702,7 +723,7 @@ git_exception() { |
702 | 723 | virtual const char *what() const throw() { return message_; } |
703 | 724 | ``` |
704 | 725 |
|
705 | | -## Contributions |
| 726 | +## Contributing |
706 | 727 |
|
707 | 728 | `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. |
708 | 729 |
|
|
0 commit comments