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

diff --git a/README b/README
index b9a7cc63..fb627ca1 100644
--- a/README
+++ b/README
@@ -1,8 +1,11 @@
 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
-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.
@@ -28,14 +31,38 @@ Makefiles and equivalents:
    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.)
+
+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.
+
+   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.
 
+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/