[libgit2.git] / examples / README.md

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
Commit	Line	Data
13f9eb24 MS	1	libgit2 examples
	2	================
	3
76120863 RB	4	These examples are a mixture of basic emulation of core Git command line
	5	functions and simple snippets demonstrating libgit2 API usage (for use
	6	with Docurium). As a whole, they are not vetted carefully for bugs, error
	7	handling, and cross-platform compatibility in the same manner as the rest
	8	of the code in libgit2, so copy with caution.
6b9a49cd	9
76120863	10	That being said, you are welcome to copy code from these examples as
dcfdb977 BS	11	desired when using libgit2. They have been [released to the public domain][cc0],
	12	so there are no restrictions on their use.
	13
	14	[cc0]: COPYING
13f9eb24	15
76120863 RB	16	For annotated HTML versions, see the "Examples" section of:
	17
	18	http://libgit2.github.com/libgit2
	19
	20	such as:
	21
	22	http://libgit2.github.com/libgit2/ex/HEAD/general.html