X-Git-Url: https://asedeno.scripts.mit.edu/gitweb/?a=blobdiff_plain;f=README;h=d38910a592c5b6f197eb40b4b47ec9b0ae8c8a53;hb=0edefb1809a783e8302ac2faf604e99729c6cda0;hp=b9a7cc63e1fa6302906e7835a8dd27a402ae7ee4;hpb=fb8d264f28c5741e56c2b0723f360ce2aab80511;p=PuTTY.git

diff --git a/README b/README
index b9a7cc63..d38910a5 100644
--- a/README
+++ b/README
@@ -2,7 +2,10 @@ This is the README for the source archive of PuTTY, a free Win32
 Telnet and SSH client.
 
 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:
 
  - Makefile.vc is for command-line builds on MS Visual C++ systems.
    Type `nmake -f Makefile.vc' to build all the PuTTY binaries.
@@ -31,11 +34,33 @@ Makefiles and equivalents:
    time of writing this 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.)
+
+For building on Unix:
+
+ - unix/Makefile.gtk is for Unix and GTK. If you don't have GTK, you
+   should still be able to build the command-line utilities (PSCP,
+   PSFTP, Plink, PuTTYgen) using this makefile. The makefile expects
+   you to change into the `unix' subdirectory, then run `make -f
+   Makefile.gtk'. 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.
+
+   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.
 
+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/