Add support for generating project files for use with Dev-C++, contributed

[u/mdw/putty] / README

diff --git a/README b/README
index 20d5aab..5b6d9cb 100644 (file)
--- a/README
+++ b/README
@@ -8,61 +8,82 @@ below.)
 
 For building on Windows:
 
 
 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.
+ - windows/Makefile.vc is for command-line builds on MS Visual C++
+   systems. Change into the `windows' subdirectory and type `nmake
+   -f Makefile.vc' to build all the PuTTY binaries.
+
+   Last time we checked, PuTTY built with vanilla VC7, or VC6 with
+   the Platform SDK.

 
    (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.)
 
 
    (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.
+ - Inside the windows/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.
 
 
    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.
+ - windows/Makefile.bor is for the Borland C compiler. Type `make -f
+   Makefile.bor' while in the `windows' subdirectory 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
+ - 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.
 
    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.)
+ - 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.

 
 For building on Unix:
 
 
 For building on Unix:
 

- - unix/Makefile.gtk is for Unix and GTK. If you don't have GTK, you
+ - unix/configure is for Unix and GTK. If you don't have GTK, you

    should still be able to build the command-line utilities (PSCP,
    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
+   PSFTP, Plink, PuTTYgen) using this script. To use it, change
+   into the `unix' subdirectory, run `./configure' and then `make'.
+
+   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.
 
    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.
+ - Both Unix Makefiles have an `install' target. Note that by default
+   it tries to install `man' pages, which you may need to have 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.
 

+The Unix `configure' script and its various requirements are generated
+by the shell script `mkauto.sh', which requires GNU Autoconf, GNU
+Automake, and Gtk; if you've got the source from Subversion rather
+than using one of our source snapshots, you'll need to run this
+yourself.
+

 Documentation (in various formats including Windows Help and Unix
 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/>.
+`man' pages) is built from the Halibut (`.but') files in the `doc'
+subdirectory using `doc/Makefile'. If you aren't using one of our
+source snapshots, you'll need to do this yourself. Halibut can be
+found at <http://www.chiark.greenend.org.uk/~sgtatham/halibut/>.

 
 The PuTTY home web site is
 
 
 The PuTTY home web site is