On Windows, character set specifications of the form 'IBM437' would never have

[u/mdw/putty] / README

diff --git a/README b/README
index 68eb2c8..24789b3 100644 (file)
--- a/README
+++ b/README
@@ -6,6 +6,11 @@ Makefiles and equivalents. (If you have fetched the source from
 Subversion, you'll have to generate the Makefiles yourself -- see
 below.)
 
+There are various compile-time directives that you can use to
+disable or modify certain features; it may be necessary to do this
+in some environments. They are documented in `Recipe', and in
+comments in many of the generated Makefiles.
+
 For building on Windows:
 
  - windows/Makefile.vc is for command-line builds on MS Visual C++
@@ -13,12 +18,14 @@ For building on Windows:
    -f Makefile.vc' to build all the PuTTY binaries.
 
    Last time we checked, PuTTY built with vanilla VC7, or VC6 with
-   the Platform SDK.
+   an up-to-date Platform SDK. (It might still be possible to build
+   with vanilla VC6, but you'll certainly have to remove some
+   functionality with directives such as NO_IPV6.)
 
-   (We've also had one report of success building with the
+   (We've also had reports 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.)
+   haven't tried this ourselves. Version 1.3 is reported to work.)
 
  - Inside the windows/MSVC subdirectory are MS Visual Studio project
    files for doing GUI-based builds of the various PuTTY utilities.
@@ -35,14 +42,25 @@ For building on Windows:
 
  - windows/Makefile.cyg is for Cygwin / mingw32 installations. Type
    `make -f Makefile.cyg' while in the `windows' subdirectory to
-   build all the PuTTY binaries. Note that by default the multiple
-   monitor support is excluded from the Cygwin build, since at the
-   time of writing Cygwin doesn't include the necessary headers.
+   build all the PuTTY binaries.
+
+   You'll probably need quite a recent version of the w32api package.
+   Note that by default the multiple monitor and HTML Help support are
+   excluded from the Cygwin build, since at the time of writing Cygwin
+   doesn't include the necessary headers.
 
  - windows/Makefile.lcc is for lcc-win32. Type `make -f
    Makefile.lcc' while in the `windows' subdirectory. (You will
    probably need to specify COMPAT=-DNO_MULTIMON.)
 
+ - Inside the windows/DEVCPP subdirectory are Dev-C++ project
+   files for doing GUI-based builds of the various PuTTY utilities.
+
+The PuTTY team actively use Makefile.vc (with VC7) and Makefile.cyg
+(with mingw32), so we'll probably notice problems with those
+toolchains fairly quickly. Please report any problems with the other
+toolchains mentioned above.
+
 For building on Unix:
 
  - unix/configure is for Unix and GTK. If you don't have GTK, you
@@ -53,13 +71,16 @@ For building on Unix:
    Note that Unix PuTTY has mostly only been tested on Linux so far;
    portability problems such as BSD-style ptys or different header file
    requirements are expected.
- 
- - unix/Makefile.gtk is for non-autoconfigured builds. This makefile
-   expects you to change into the `unix' subdirectory, then run `make
-   -f Makefile.gtk'.
 
- - For the graphical utilities, Gtk+-1.2 is required. Gtk+-2.0 is not
-   yet supported.
+ - unix/Makefile.gtk and unix/Makefile.ux are for non-autoconfigured
+   builds. These makefiles expect you to change into the `unix'
+   subdirectory, then run `make -f Makefile.gtk' or `make -f
+   Makefile.ux' respectively. Makefile.gtk builds all the programs but
+   relies on Gtk, whereas Makefile.ux builds only the command-line
+   utilities and has no Gtk dependence.
+
+ - For the graphical utilities, Gtk+-1.2 and Gtk+-2.0 should both be
+   supported.
 
  - Both Unix Makefiles have an `install' target. Note that by default
    it tries to install `man' pages, which you may need to have built