summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCarlos Martín Nieto <cmn@dwim.me>2013-10-23 13:17:51 +0200
committerCarlos Martín Nieto <cmn@dwim.me>2013-10-23 13:46:33 +0200
commit2baee9f81e6a7d8b5e9e31269908ec0d25610b4e (patch)
tree81f7705ba187fa8240404afabf014deae8c1d8c2 /README.md
parent1ecda61ec570873dd72fd129cd1bfe6a08d5a81a (diff)
downloadlibgit2-2baee9f81e6a7d8b5e9e31269908ec0d25610b4e.tar.gz
README: add a note about the optional dependencies
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0d735c397..f400a9fae 100644
--- a/README.md
+++ b/README.md
@@ -43,6 +43,17 @@ and also powering Microsoft's Visual Studio tools for Git. The library provides
* descriptive and detailed error messages
* ...and more (over 175 different API calls)
+Optional dependencies
+=====================
+
+While the library provides git functionality without the need for
+dependencies, it can make use of a few libraries to add to it:
+
+- pthreads (non-Windows) to enable threadsafe access as well as multi-threaded pack generation
+- OpenSSL (non-Windows) to talk over HTTPS and provide the SHA-1 functions
+- LibSSH2 to enable the ssh transport
+- iconv (OSX) to handle the HFS+ path encoding peculiarities
+
Building libgit2 - Using CMake
==============================