X-Git-Url: https://git.distorted.org.uk/u/mdw/putty/blobdiff_plain/b9c299bb01944aebf53047ef29a39cca2c3c9492..58de2f3c7d0312d782a9940c898399f473fb2a2b:/README

diff --git a/README b/README
index 44f650a4..b9a7cc63 100644
--- a/README
+++ b/README
@@ -1,21 +1,48 @@
-This is the README for PuTTY, a free Win32 Telnet and SSH client.
+This is the README for the source archive of PuTTY, a free Win32
+Telnet and SSH client.
 
-The provided Makefile is for MS Visual C++ systems. Type `nmake' to
-build both putty.exe (the main program) and pscp.exe (an SCP
-client).
+If you want to rebuild PuTTY from source, we provide a variety of
+Makefiles and equivalents:
 
-Setting up a project file in the Visual C++ IDE sometimes fails to
-work. In particular, Visual Studio 6 falls over on the odd macro
-usage in ssh.c. This is a bug in Visual Studio, since the VC++6
-command line compiler works fine. If in doubt, just use `nmake'.
+ - Makefile.vc is for command-line builds on MS Visual C++ systems.
+   Type `nmake -f Makefile.vc' to build all the PuTTY binaries.
+
+   (We've also had one report of success building with the
+   OpenWatcom compiler -- www.openwatcom.org -- using Makefile.vc
+   with `wmake -ms -f makefile.vc' and NO_MULTIMON, although we
+   haven't tried this ourselves.)
+
+ - Inside the MSVC subdirectory are MS Visual Studio project files
+   for doing GUI-based builds of the various PuTTY utilities. These
+   have been tested on Visual Studio 6.
+
+   You should be able to build each PuTTY utility by loading the
+   corresponding .dsp file in Visual Studio. For example,
+   MSVC/putty/putty.dsp builds PuTTY itself, MSVC/plink/plink.dsp
+   builds Plink, and so on.
+
+ - Makefile.bor is for the Borland C compiler. Type `make -f
+   Makefile.bor' to build all the PuTTY binaries.
+
+ - Makefile.cyg is for Cygwin / mingw32 installations. Type `make -f
+   Makefile.cyg' to build all the PuTTY binaries. Note that by
+   default the Pageant WinNT security features and the multiple
+   monitor support are excluded from the Cygwin build, since at the
+   time of writing this Cygwin doesn't include the necessary
+   headers.
+
+All of the Makefiles are generated automatically from the file
+`Recipe' by the Perl script `mkfiles.pl'. Additions and corrections
+to Recipe and the mkfiles.pl are much more useful than additions and
+corrections to the alternative Makefiles themselves.
 
 The PuTTY home web site is
 
-    http://www.chiark.greenend.org.uk/~sgtatham/putty.html
+    http://www.chiark.greenend.org.uk/~sgtatham/putty/
 
-Bug reports and feature requests should be sent to
-<putty-bugs@lists.tartarus.org>. PLEASE read the section on the web
-site about how to report bugs effectively. Do NOT send one-line
-reports saying `it doesn't work'!
+If you want to send bug reports or feature requests, please read the
+Feedback section of the web site before doing so. Sending one-line
+reports saying `it doesn't work' will waste your time as much as
+ours.
 
 See the file LICENCE for the licence conditions.