From 2baee9f81e6a7d8b5e9e31269908ec0d25610b4e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20Mart=C3=ADn=20Nieto?= Date: Wed, 23 Oct 2013 13:17:51 +0200 Subject: [PATCH] README: add a note about the optional dependencies --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) 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 ==============================