summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCarlos Martín Nieto <cmn@dwim.me>2014-12-14 16:18:09 +0100
committerCarlos Martín Nieto <cmn@dwim.me>2014-12-14 16:19:08 +0100
commited09e04462ffbdd1ccf86340fad37e6aa4911449 (patch)
tree200f4aa2766c8f1b887d4fbee077d2a2e24b1a2a /README.md
parent4eb97ef3bf18403fbce351ae4cac673655d2886a (diff)
downloadlibgit2-ed09e04462ffbdd1ccf86340fad37e6aa4911449.tar.gz
Mention the init function in the READMEcmn/init-readme
This fixes #2731.
Diffstat (limited to 'README.md')
-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
=========