Talk about Halibut; mention Unix `install' target; mention lack of Makefiles
authorjacob <jacob@cda61777-01e9-0310-a592-d414129be87e>
Thu, 29 Jul 2004 10:09:25 +0000 (10:09 +0000)
committerjacob <jacob@cda61777-01e9-0310-a592-d414129be87e>
Thu, 29 Jul 2004 10:09:25 +0000 (10:09 +0000)
if you check out directly from CVS as it's come up once or twice.

git-svn-id: svn://svn.tartarus.org/sgt/putty@4370 cda61777-01e9-0310-a592-d414129be87e

README

diff --git a/README b/README
index 7ffb097..d38910a 100644 (file)
--- a/README
+++ b/README
@@ -2,7 +2,8 @@ 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:
 
@@ -46,11 +47,20 @@ For building on Unix:
    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/