diff options
| author | Vicent Martà <vicent@github.com> | 2013-11-01 09:38:34 -0700 |
|---|---|---|
| committer | Vicent Martà <vicent@github.com> | 2013-11-01 09:38:34 -0700 |
| commit | 567649f2ada60e5c3009cc985af238b452b14a81 (patch) | |
| tree | 12a19dd97c05818557228ed2b3fcc36e183959b2 /examples/README.md | |
| parent | 948f00b4e79bb60c68e03342500013246e642ae6 (diff) | |
| parent | 4f62d55968d4a22a6ea03194aa34ab1b6ca8fdea (diff) | |
| download | libgit2-567649f2ada60e5c3009cc985af238b452b14a81.tar.gz | |
Merge pull request #1916 from libgit2/simplify-examples
Fix examples to make the important stuff more obvious
Diffstat (limited to 'examples/README.md')
| -rw-r--r-- | examples/README.md | 20 |
1 files changed, 14 insertions, 6 deletions
diff --git a/examples/README.md b/examples/README.md index f2b6d7d23..494d3291a 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,11 +1,19 @@ libgit2 examples ================ -These examples are meant as thin, easy-to-read snippets for Docurium -(https://github.com/github/docurium) rather than full-blown -implementations of Git commands. They are not vetted as carefully -for bugs, error handling, or cross-platform compatibility as the -rest of the code in libgit2, so copy with some caution. +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. -For HTML versions, check "Examples" at http://libgit2.github.com/libgit2 +That being said, you are welcome to copy code from these examples as +desired when using libgit2. +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 |