summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorRay Imber <rayimber@gmail.com>2020-07-27 23:04:04 -0700
committerGitHub <noreply@github.com>2020-07-28 02:04:04 -0400
commitd60fae576f3228c1cee360129b687a1e8c6a8ed8 (patch)
tree0c2a6c290285b42c102fc9f93f1db2eca5db6e3a
parente6f0d4a5a59f8230133481d25ce1c3f6e8daf0a5 (diff)
downloadNim-d60fae576f3228c1cee360129b687a1e8c6a8ed8.tar.gz
Improvements to Windows install instructions (#15099)
-rw-r--r--readme.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/readme.md b/readme.md
index 94241822f..4ef10f231 100644
--- a/readme.md
+++ b/readme.md
@@ -52,6 +52,12 @@ Next, to build from source you will need:
   * Either ``git`` or ``wget`` to download the needed source repositories.
   * The ``build-essential`` package when using ``gcc`` on Ubuntu (and likely
     other distros as well).
+  * On Windows MinGW 4.3.0 (GCC 8.10) is the minimum recommended compiler.
+  * Nim hosts a known working MinGW distribution:
+    * [MinGW32.7z](https://nim-lang.org/download/mingw32.7z)
+    * [MinGW64.7z](https://nim-lang.org/download/mingw64.7z)
+
+**Windows Note: Cygwin and similar posix runtime environments are not supported.**
 
 Then, if you are on a \*nix system or Windows, the following steps should compile
 Nim from source using ``gcc``, ``git`` and the ``koch`` build tool.
@@ -75,6 +81,9 @@ Next run the appropriate build shell script for your platform:
 * `build_all.sh` (Linux, Mac)
 * `build_all.bat` (Windows)
 
+Windows requires a number of other dependencies that you may need to install including
+PCRE and OpenSSL. Nim hosts a zip package containing known working versions of the
+required DLLs [here](https://nim-lang.org/download/dlls.zip).
 
 Finally, once you have finished the build steps (on Windows, Mac or Linux) you
 should add the ``bin`` directory to your PATH.