Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/mono/libgit2.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEdward Thomson <ethomson@edwardthomson.com>2014-12-21 06:23:55 +0300
committerEdward Thomson <ethomson@edwardthomson.com>2014-12-21 06:23:55 +0300
commit25a03d4ad4a5ff9c3cdacb788c6ef3fbd3679b5c (patch)
treede1a471348e0f58b86c591384a4797df91594a76
parentc7d9839f54f62849ef528b97b60a39fd21f54c5a (diff)
parented09e04462ffbdd1ccf86340fad37e6aa4911449 (diff)
Merge pull request #2760 from libgit2/cmn/init-readme
Mention the init function in the README
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index ec74f23ea..2b3ee27d4 100644
--- a/README.md
+++ b/README.md
@@ -59,6 +59,19 @@ dependencies, it can make use of a few libraries to add to it:
- LibSSH2 to enable the SSH transport
- iconv (OSX) to handle the HFS+ path encoding peculiarities
+Initialization
+===============
+
+The library needs to keep track of some global state. Call
+
+ git_libgit2_init();
+
+before calling any other libgit2 functions. You can call this function many times. A matching number of calls to
+
+ git_libgit2_shutdown();
+
+will free the resources.
+
Threading
=========