Slight cleanup of the collection of READMEs, INSTALLs and NOTES
authorRichard Levitte <levitte@openssl.org>
Mon, 23 May 2016 13:11:04 +0000 (15:11 +0200)
committerRichard Levitte <levitte@openssl.org>
Mon, 23 May 2016 14:02:53 +0000 (16:02 +0200)
README is a fairly independent document, and so is INSTALL.  NOTES are
merely addendums to INSTALL.  Therefore , INSTALL.DJGPP and
README.PERL get renamed to NOTES.DJGPP and NOTES.PERL.

Reviewed-by: Rich Salz <rsalz@openssl.org>
INSTALL
NOTES.DJGPP [moved from INSTALL.DJGPP with 98% similarity]
NOTES.PERL [moved from README.PERL with 100% similarity]
NOTES.WIN
README

diff --git a/INSTALL b/INSTALL
index bdf67a6..ab35353 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -2,15 +2,15 @@
  OPENSSL INSTALLATION
  --------------------
 
- [This document describes installation on the main supported operating
-  systems, currently the Linux/Unix family, OpenVMS and Windows.
-  Installation on DOS (with djgpp) is described in INSTALL.DJGPP.]
+ [This document describes installation on all supported operating
+  systems (currently mainly the Linux/Unix family, OpenVMS and
+  Windows)]
 
  To install OpenSSL, you will need:
 
-  * make
-  * Perl 5 with core modules (please read README.PERL)
-  * The perl module Text::Template (please read README.PERL)
+  * A make implementation
+  * Perl 5 with core modules (please read NOTES.PERL)
+  * The perl module Text::Template (please read NOTES.PERL)
   * an ANSI C compiler
   * a development environment in the form of development libraries and C
     header files
@@ -21,6 +21,7 @@
 
   * NOTES.VMS (OpenVMS)
   * NOTES.WIN (any supported Windows)
+  * NOTES.DJGPP (DOS platform with DJGPP)
 
  Quick Start
  -----------
similarity index 98%
rename from INSTALL.DJGPP
rename to NOTES.DJGPP
index 4fd94e4..bbe63dc 100644 (file)
@@ -12,7 +12,7 @@
  You should have a full DJGPP environment installed, including the
  latest versions of DJGPP, GCC, BINUTILS, BASH, etc. This package
  requires that PERL and the PERL module Text::Template also be
- installed.
+ installed (see NOTES.PERL).
 
  All of these can be obtained from the usual DJGPP mirror sites or
  directly at "http://www.delorie.com/pub/djgpp". For help on which
similarity index 100%
rename from README.PERL
rename to NOTES.PERL
index bed5037..a2e9120 100644 (file)
--- a/NOTES.WIN
+++ b/NOTES.WIN
@@ -5,10 +5,13 @@
  Requirement details for native (Visual C++) builds
  --------------------------------------------------
 
+ In addition to the requirements and instructions listed in INSTALL,
+ this are required as well:
+
  - You need Perl.  We recommend ActiveState Perl, available from
    http://www.activestate.com/ActivePerl.
    You also need the perl module Text::Template, available on CPAN.
-   Please read README.PERL for more information.
+   Please read NOTES.PERL for more information.
 
  - You need a C compiler.  OpenSSL has been tested to build with these:
 
diff --git a/README b/README
index e32844e..1672580 100644 (file)
--- a/README
+++ b/README
@@ -48,8 +48,8 @@
  ------------
 
  See the appropriate file:
-        INSTALL         Linux, Unix, Windows, OpenVMS
-        INSTALL.DJGPP   DOS platform with DJGPP
+        INSTALL         Linux, Unix, Windows, OpenVMS, ...
+        NOTES.*         INSTALL addendums for different platforms
 
  SUPPORT
  -------