X-Git-Url: https://asedeno.scripts.mit.edu/gitweb/?a=blobdiff_plain;ds=inline;f=README;h=991164e583758ea11fb214658da10231617ede8c;hb=162d04d360d8d70269ad17a02d44a983cb8dbfef;hp=44f650a48108e62d06632c84c6f991ca1b5de862;hpb=b5c923f250e5fc8be7b85be4167ac3c3d292c3f2;p=PuTTY.git
diff --git a/README b/README
index 44f650a4..991164e5 100644
--- a/README
+++ b/README
@@ -1,21 +1,84 @@
-This is the README for PuTTY, a free Win32 Telnet and SSH client.
+This is the README for the source archive of PuTTY, a free Win32
+and Unix Telnet and SSH client.
-The provided Makefile is for MS Visual C++ systems. Type `nmake' to
-build both putty.exe (the main program) and pscp.exe (an SCP
-client).
+If you want to rebuild PuTTY from source, we provide a variety of
+Makefiles and equivalents. (If you have fetched the source from
+Subversion, you'll have to generate the Makefiles yourself -- see
+below.)
-Setting up a project file in the Visual C++ IDE sometimes fails to
-work. In particular, Visual Studio 6 falls over on the odd macro
-usage in ssh.c. This is a bug in Visual Studio, since the VC++6
-command line compiler works fine. If in doubt, just use `nmake'.
+For building on Windows:
+
+ - 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.
+
+ (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 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.
+
+ - 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.
+
+ - 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.
+
+ - 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.)
+
+For building on Unix:
+
+ - 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,
+ PSFTP, Plink, PuTTYgen) using this script. To use it, change
+ into the `unix' subdirectory, run `./configure' and then `make'.
+
+ - unix/Makefile.gtk is for non-autoconfigured builds. This 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. The Unix `configure'
+script and its various requirements are generated by the shell script
+`mkauto.sh', which requires GNU Autoconf, GNU Automake, and Gtk.
+
+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
+.
The PuTTY home web site is
- http://www.chiark.greenend.org.uk/~sgtatham/putty.html
+ http://www.chiark.greenend.org.uk/~sgtatham/putty/
-Bug reports and feature requests should be sent to
-. PLEASE read the section on the web
-site about how to report bugs effectively. Do NOT send one-line
-reports saying `it doesn't work'!
+If you want to send bug reports or feature requests, please read the
+Feedback section of the web site before doing so. Sending one-line
+reports saying `it doesn't work' will waste your time as much as
+ours.
See the file LICENCE for the licence conditions.