summaryrefslogtreecommitdiff
path: root/examples/README.md
blob: 769c4b2678af12c175c7673dc9e0f29c29682ecd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
libgit2 examples
================

These examples are a mixture of basic emulation of core Git command line
functions and simple snippets demonstrating libgit2 API usage (for use
with Docurium).  As a whole, they are not vetted carefully for bugs, error
handling, and cross-platform compatibility in the same manner as the rest
of the code in libgit2, so copy with caution.

That being said, you are welcome to copy code from these examples as
desired when using libgit2. They have been [released to the public domain][cc0],
so there are no restrictions on their use.

[cc0]: COPYING

For annotated HTML versions, see the "Examples" section of:

    http://libgit2.github.com/libgit2

such as:

    http://libgit2.github.com/libgit2/ex/HEAD/general.html