summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEdward Thomson <ethomson@edwardthomson.com>2020-05-11 21:06:42 +0100
committerGitHub <noreply@github.com>2020-05-11 21:06:42 +0100
commit31ddf16333e47292a417d01a055636bbb69177ae (patch)
treebe7401782d352a0400097c52f46f8d944921b75f
parentb83bc6d4739d10ac3db6513931cedfe8e682f487 (diff)
parent4ad363386d1dccb328825eb6390886ec791e5b40 (diff)
downloadlibgit2-31ddf16333e47292a417d01a055636bbb69177ae.tar.gz
Merge pull request #5512 from A-Ovchinnikov-mx/patch-1
README.md: Add instructions for building in MinGW environment
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
index 516077a5f..a91f16067 100644
--- a/README.md
+++ b/README.md
@@ -47,6 +47,7 @@ Table of Contents
* [Compiler and linker options](#compiler-and-linker-options)
* [MacOS X](#macos-x)
* [Android](#android)
+ * [MinGW](#mingw)
* [Language Bindings](#language-bindings)
* [How Can I Contribute?](#how-can-i-contribute)
* [License](#license)
@@ -304,6 +305,20 @@ with full path to the toolchain):
Add `-DCMAKE_TOOLCHAIN_FILE={pathToToolchainFile}` to cmake command
when configuring.
+MinGW
+-----
+
+If you want to build the library in MinGW environment with SSH support enabled,
+you may need to pass `-DCMAKE_LIBRARY_PATH="${MINGW_PREFIX}/${MINGW_CHOST}/lib/"` flag
+to CMake when configuring. This is because CMake cannot find the Win32 libraries in
+MinGW folders by default and you might see an error message stating that CMake
+could not resolve `ws2_32` library during configuration.
+
+Another option would be to install `msys2-w32api-runtime` package before configuring.
+This package installs the Win32 libraries into `/usr/lib` folder which is by default
+recognized as the library path by CMake. Please note though that this package is meant
+for MSYS subsystem which is different from MinGW.
+
Language Bindings
==================================