Note upper limit of WM_SYSCOMMAND identifiers in a comment.
[sgt/putty] / README
diff --git a/README b/README
index 7ffb097..fb627ca 100644 (file)
--- a/README
+++ b/README
@@ -1,8 +1,9 @@
 This is the README for the source archive of PuTTY, a free Win32
 This is the README for the source archive of PuTTY, a free Win32
-Telnet and SSH client.
+and Unix Telnet and SSH client.
 
 If you want to rebuild PuTTY from source, we provide a variety of
 
 If you want to rebuild PuTTY from source, we provide a variety of
-Makefiles and equivalents.
+Makefiles and equivalents. (If you have fetched the source from CVS,
+you'll have to generate the Makefiles yourself -- see below.)
 
 For building on Windows:
 
 
 For building on Windows:
 
@@ -30,8 +31,7 @@ For building on Windows:
    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
    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.
+   time of writing Cygwin doesn't include the necessary headers.
 
  - Makefile.lcc is for lcc-win32. Type `make -f Makefile.lcc'. (You
    will probably need to specify COMPAT=-DNO_MULTIMON.)
 
  - Makefile.lcc is for lcc-win32. Type `make -f Makefile.lcc'. (You
    will probably need to specify COMPAT=-DNO_MULTIMON.)
@@ -46,11 +46,23 @@ For building on Unix:
    on Linux so far; portability problems such as BSD-style ptys or
    different header file requirements are expected.
 
    on Linux so far; portability problems such as BSD-style ptys or
    different header file requirements are expected.
 
+   For the graphical utilities, Gtk+-1.2 is required. Gtk+-2.0 is not
+   yet supported.
+
+   There is an `install' target; note that by default it tries to
+   install `man' pages, which need to be built using Halibut first --
+   see below.
+
 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.
 
 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.
 
+Documentation (in various formats including Windows Help and Unix
+`man' pages) is to be built from the Halibut (`.but') files in the
+`doc' subdirectory using `doc/Makefile'. Halibut can be found at
+<http://www.chiark.greenend.org.uk/~sgtatham/halibut/>.
+
 The PuTTY home web site is
 
     http://www.chiark.greenend.org.uk/~sgtatham/putty/
 The PuTTY home web site is
 
     http://www.chiark.greenend.org.uk/~sgtatham/putty/