Mention Windows SDK compat in installation docs
authorKirill Isakov <bootctl@gmail.com>
Fri, 25 Mar 2022 12:44:39 +0000 (18:44 +0600)
committerKirill Isakov <bootctl@gmail.com>
Sun, 27 Mar 2022 20:03:57 +0000 (02:03 +0600)
INSTALL.md
doc/tinc.texi

index 3265e54..fb99d03 100644 (file)
@@ -35,13 +35,21 @@ Please consult your operating system's documentation for more details.
 
 ## Windows
 
-You will need to install [msys2][msys2] to build tinc under Windows.
+You can build tinc using either the native [Windows SDK][sdk-ms] (which comes with Visual Studio),
+or with the Unix-like [msys2 environment][sdk-msys2]. Install either one of them, plus
+the latest version of [meson][meson-release].
 
-[msys2]: https://msys2.org/
+If you prefer the native SDK, you might want to work on tinc (or build it) under Visual Studio.
+To do so, follow [these instructions][meson-vs].
 
 By default, tinc produces a static Windows build, so you don't need to install anything
 in order to _run_ the compiled binaries.
 
+[sdk-ms]: https://visualstudio.com/
+[sdk-msys2]: https://msys2.org/
+[meson-release]: https://github.com/mesonbuild/meson/releases
+[meson-vs]: https://mesonbuild.com/Using-with-Visual-Studio.html
+
 # Building
 
 ## Native
index ed9f3ae..2e519d1 100644 (file)
@@ -571,7 +571,7 @@ The documentation that comes along with your distribution will tell you how to d
 
 @menu
 * Darwin (MacOS/X) build environment::
-* MinGW (Windows) build environment::
+* Windows build environment::
 @end menu
 
 
@@ -586,14 +586,16 @@ You need to download and install LibreSSL (or OpenSSL) and LZO,
 either directly from their websites (see @ref{Libraries}) or using Fink.
 
 @c ==================================================================
-@node       MinGW (Windows) build environment
-@subsection MinGW (Windows) build environment
+@node       Windows build environment
+@subsection Windows build environment
+
+You will need to install either the native Windows SDK from @uref{https://visualstudio.com},
+or the MinGW environment from @uref{https://msys2.org}.
 
-You will need to install the MinGW environment from @uref{http://www.mingw.org}.
 You also need to download and install LibreSSL (or OpenSSL) and LZO.
 
-When tinc is compiled using MinGW it runs natively under Windows,
-it is not necessary to keep MinGW installed.
+Whether tinc is compiled using MinGW or the native SDK, it runs natively under Windows,
+so it is not necessary to keep either SDK to run the compiled binaries.
 
 When detaching, tinc will install itself as a service,
 which will be restarted automatically after reboots.