Rename NOTES*, README*, VERSION, HACKING, LICENSE to .md or .txt

Reviewed-by: Tim Hudson <tjh@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/12109)

47 files changed, 313 insertions, 107 deletions

diff --git a/CHANGES.md b/CHANGES.md
index 585a451d18..c0140a35bb 100644
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -173,7 +173,13 @@ OpenSSL 3.0
 
    *Richard Levitte*
 
- * The main project documents (README, NEWS, CHANGES, INSTALL, SUPPORT)
+ * Project text documents not yet having a proper file name extension
+   (HACKING, LICENSE, NOTES*, README*, VERSION) have been renamed to *.md
+   as far as reasonable, else to *.txt, for better use with file managers.
+
+   *David von Oheimb*
+
+*  The main project documents (README, NEWS, CHANGES, INSTALL, SUPPORT)
    have been converted to Markdown with the goal to produce documents
    which not only look pretty when viewed online in the browser, but
    remain well readable inside a plain text editor.
@@ -3104,12 +3110,12 @@ OpenSSL 1.1.0
 
  * State machine rewrite. The state machine code has been significantly
    refactored in order to remove much duplication of code and solve issues
-   with the old code (see ssl/statem/README for further details). This change
-   does have some associated API changes. Notably the SSL_state() function
-   has been removed and replaced by SSL_get_state which now returns an
-   "OSSL_HANDSHAKE_STATE" instead of an int. SSL_set_state() has been removed
-   altogether. The previous handshake states defined in ssl.h and ssl3.h have
-   also been removed.
+   with the old code (see [ssl/statem/README.md](ssl/statem/README.md) for
+   further details). This change does have some associated API changes.
+   Notably the SSL_state() function has been removed and replaced by
+   SSL_get_state which now returns an "OSSL_HANDSHAKE_STATE" instead of an int.
+   SSL_set_state() has been removed altogether. The previous handshake states
+   defined in ssl.h and ssl3.h have also been removed.
 
    *Matt Caswell*
 
@@ -11587,7 +11593,8 @@ OpenSSL 0.9.7.]
    of specific crypto interfaces. This change also introduces integrated
    support for symmetric ciphers and digest implementations - so ENGINEs
    can now accelerate these by providing EVP_CIPHER and EVP_MD
-   implementations of their own. This is detailed in crypto/engine/README
+   implementations of their own. This is detailed in
+   [crypto/engine/README.md](crypto/engine/README.md)
    as it couldn't be adequately described here. However, there are a few
    API changes worth noting - some RSA, DSA, DH, and RAND functions that
    were changed in the original introduction of ENGINE code have now
@@ -11663,7 +11670,7 @@ OpenSSL 0.9.7.]
    makes them more flexible to be built both as statically-linked ENGINEs
    and self-contained shared-libraries loadable via the "dynamic" ENGINE.
    Also, add stub code to each that makes building them as self-contained
-   shared-libraries easier (see README.ENGINE).
+   shared-libraries easier (see [README-Engine.md](README-Engine.md)).
 
    *Geoff Thorpe*
 
@@ -11672,7 +11679,8 @@ OpenSSL 0.9.7.]
    self-contained shared-libraries. The "dynamic" ENGINE exposes control
    commands that can be used to configure what shared-library to load and
    to control aspects of the way it is handled. Also, made an update to
-   the README.ENGINE file that brings its information up-to-date and
+   the [README-Engine.md](README-Engine.md) file
+   that brings its information up-to-date and
    provides some information and instructions on the "dynamic" ENGINE
    (ie. how to use it, how to build "dynamic"-loadable ENGINEs, etc).
 
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 23756a5d4a..96290fffca 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -64,7 +64,7 @@ guidelines:
 
  5. When at all possible, patches should include tests. These can
     either be added to an existing test, or completely new.  Please see
-    test/README for information on the test framework.
+    test/README.md for information on the test framework.
 
  6. New features or changed functionality must include
     documentation. Please look at the "pod" files in doc/man[1357] for
diff --git a/Configurations/15-android.conf b/Configurations/15-android.conf
index d3b2ff6a1c..77d6c8b47d 100644
--- a/Configurations/15-android.conf
+++ b/Configurations/15-android.conf
@@ -1,6 +1,6 @@
 #### Android...
 #
-# See NOTES.ANDROID for details, and don't miss platform-specific
+# See NOTES-Android.md for details, and don't miss platform-specific
 # comments below...
 
 {
diff --git a/Configurations/README.design b/Configurations/README-design.md
index b79d0b2e49..b79d0b2e49 100644
--- a/Configurations/README.design
+++ b/Configurations/README-design.md
diff --git a/Configurations/README b/Configurations/README.md
index a0618ca2d3..a0618ca2d3 100644
--- a/Configurations/README
+++ b/Configurations/README.md
diff --git a/Configure b/Configure
index b8dfeec477..df42603855 100755
--- a/Configure
+++ b/Configure
@@ -301,7 +301,7 @@ foreach ( reverse sort( 'aes', 'aria', 'bf', 'camellia', 'cast', 'des', 'dh',
 my %version = ();
 
 collect_information(
-    collect_from_file(catfile($srcdir,'VERSION')),
+    collect_from_file(catfile($srcdir,'VERSION.dat')),
     qr/\s*(\w+)\s*=\s*(.*?)\s*$/ =>
         sub {
             # Only define it if there is a value at all
@@ -314,7 +314,7 @@ collect_information(
             }
         },
     "OTHERWISE" =>
-        sub { die "Something wrong with this line:\n$_\nin $srcdir/VERSION" },
+        sub { die "Something wrong with this line:\n$_\nin $srcdir/VERSION.dat" },
     );
 
 $config{major} = $version{MAJOR} // 'unknown';
@@ -330,7 +330,7 @@ $config{release_date} = $version{RELEASE_DATE} // 'xx XXX xxxx';
 $config{version} = "$config{major}.$config{minor}.$config{patch}";
 $config{full_version} = "$config{version}$config{prerelease}$config{build_metadata}";
 
-die "erroneous version information in VERSION: ",
+die "erroneous version information in VERSION.dat: ",
     "$config{version}, $config{shlib_version}\n"
     unless (defined $version{MAJOR}
             && defined $version{MINOR}
diff --git a/HACKING b/HACKING.md
index abf199f541..abf199f541 100644
--- a/HACKING
+++ b/HACKING.md
diff --git a/INSTALL.md b/INSTALL.md
index 5686415ad8..dfa1276378 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -680,7 +680,8 @@ external test suites are currently supported:
  - Python PYCA/Cryptography test suite
  - krb5 test suite
 
-See the file [test/README.external](test/README.external) for further details.
+See the file [test/README-external.md](test/README-external.md)
+for further details.
 
 ### no-filenames
 
@@ -1152,8 +1153,8 @@ run:
 If your system isn't listed, you will have to create a configuration
 file named `Configurations/{{ something }}.conf` and add the correct
 configuration for your system.  See the available configs as examples
-and read [Configurations/README](Configurations/README)
-and [Configurations/README.design](Configurations/README.design)
+and read [Configurations/README.md](Configurations/README.md) and
+[Configurations/README-design.md](Configurations/README-design.md)
 for more information.
 
 The generic configurations `cc` or `gcc` should usually work on 32 bit
@@ -1223,7 +1224,9 @@ be tested.  Run:
 **Warning:** you MUST run the tests from an unprivileged account (or disable
 your privileges temporarily if your platform allows it).
 
-See the file [test/README.md](test/README.md) for further details.
+See [test/README.md](test/README.md) for further details how run tests.
+
+See [test/README-dev.md](test/README-dev.md) for guidelines on adding tests.
 
 Install OpenSSL
 ---------------
@@ -1359,7 +1362,8 @@ over the build process.  Typically these should be defined prior to running
                    Use a different build file name than the platform default
                    ("Makefile" on Unix-like platforms, "makefile" on native Windows,
                    "descrip.mms" on OpenVMS).  This requires that there is a
-                   corresponding build file template.  See Configurations/README
+                   corresponding build file template.
+                   See [Configurations/README.md](Configurations/README.md)
                    for further information.
 
     CC
@@ -1382,15 +1386,15 @@ over the build process.  Typically these should be defined prior to running
                    templates for those platforms. The database is comprised of
                    ".conf" files in the Configurations directory.  The build
                    file templates reside there as well as ".tmpl" files. See the
-                   file Configurations/README for further information about the
-                   format of ".conf" files as well as information on the ".tmpl"
-                   files.
+                   file [Configurations/README.md](Configurations/README.md)
+                   for further information about the format of ".conf" files
+                   as well as information on the ".tmpl" files.
                    In addition to the standard ".conf" and ".tmpl" files, it is
-                   possible to create your own ".conf" and ".tmpl" files and store
-                   them locally, outside the OpenSSL source tree. This environment
-                   variable can be set to the directory where these files are held
-                   and will be considered by Configure before it looks in the
-                   standard directories.
+                   possible to create your own ".conf" and ".tmpl" files and
+                   store them locally, outside the OpenSSL source tree.
+                   This environment variable can be set to the directory where
+                   these files are held and will be considered by Configure
+                   before it looks in the standard directories.
 
     PERL
                    The name of the Perl executable to use when building OpenSSL.
@@ -1534,8 +1538,8 @@ known targets. Using `grep`, you can lookup the target definition in the
 The directory contains two README files, which explain the general syntax and
 design of the configuration files.
 
- - [Configurations/README](Configurations/README)
- - [Configurations/README.design](Configurations/README.design)
+ - [Configurations/README.md](Configurations/README.md)
+ - [Configurations/README-design.md](Configurations/README-design.md)
 
 If you need further help, try to search the [openssl-users][] mailing list
 or the [GitHub Issues][] for existing solutions. If you don't find anything,
diff --git a/LICENSE b/LICENSE.txt
index 49cc83d2ee..49cc83d2ee 100644
--- a/LICENSE
+++ b/LICENSE.txt
diff --git a/NEWS.md b/NEWS.md
index 9985bbfd05..e04e5b95c8 100644
--- a/NEWS.md
+++ b/NEWS.md
@@ -1196,7 +1196,7 @@ OpenSSL 0.9.x
   * Enhanced EVP interface.
 
   [1] The support for external crypto devices is currently a separate
-      distribution.  See the file README.ENGINE.
+      distribution.  See the file README-Engine.md.
 
 ### Major changes between OpenSSL 0.9.5 and OpenSSL 0.9.5a [1 Apr 2000]
 
diff --git a/NOTES.ANDROID b/NOTES-Android.md
index 087d5e6f49..087d5e6f49 100644
--- a/NOTES.ANDROID
+++ b/NOTES-Android.md
diff --git a/NOTES.DJGPP b/NOTES-DJGPP.md
index d43d4e86de..d43d4e86de 100644
--- a/NOTES.DJGPP
+++ b/NOTES-DJGPP.md
diff --git a/NOTES.PERL b/NOTES-Perl.md
index 6c1d7c8cb1..6c1d7c8cb1 100644
--- a/NOTES.PERL
+++ b/NOTES-Perl.md
diff --git a/NOTES.UNIX b/NOTES-Unix.md
index 0e3c099ea2..0e3c099ea2 100644
--- a/NOTES.UNIX
+++ b/NOTES-Unix.md
diff --git a/NOTES.VMS b/NOTES-VMS.md
index c82e231ad7..c82e231ad7 100644
--- a/NOTES.VMS
+++ b/NOTES-VMS.md
diff --git a/NOTES.VALGRIND b/NOTES-Valgrind.md
index 0ecca4f7dc..0ecca4f7dc 100644
--- a/NOTES.VALGRIND
+++ b/NOTES-Valgrind.md
diff --git a/NOTES.WIN b/NOTES-Windows.txt
index 683e40671e..683e40671e 100644
--- a/NOTES.WIN
+++ b/NOTES-Windows.txt
diff --git a/README.ENGINE b/README-Engine.md
index 230dc82a87..230dc82a87 100644
--- a/README.ENGINE
+++ b/README-Engine.md
diff --git a/README.FIPS b/README-FIPS.md
index 859348664e..859348664e 100644
--- a/README.FIPS
+++ b/README-FIPS.md
diff --git a/README.md b/README.md
index e566d3161c..a0ea69074a 100644
--- a/README.md
+++ b/README.md
@@ -142,7 +142,7 @@ OpenSSL is licensed under the Apache License 2.0, which means that
 you are free to get and use it for commercial and non-commercial
 purposes as long as you fulfill its conditions.
 
-See the [LICENSE](LICENSE) file for more details.
+See the [LICENSE.txt](LICENSE.txt) file for more details.
 
 Support
 =======
diff --git a/VERSION b/VERSION.dat
index 2ba82bbc93..2ba82bbc93 100644
--- a/VERSION
+++ b/VERSION.dat
diff --git a/VERSION.txt b/VERSION.txt
new file mode 100644
index 0000000000..48c68bdd04
--- /dev/null
+++ b/VERSION.txt
@@ -0,0 +1,7 @@
+MAJOR=3
+MINOR=0
+PATCH=0
+PRE_RELEASE_TAG=alpha4-dev
+BUILD_METADATA=
+RELEASE_DATE=""
+SHLIB_VERSION=3
diff --git a/config.com b/config.com
index 1e1b925ab8..252cada5e9 100644
--- a/config.com
+++ b/config.com
@@ -42,7 +42,7 @@ Usage: @config [options]
   -h		This help.
 
 Any other text will be passed to the Configure perl script.
-See INSTALL for instructions.
+See INSTALL.md for instructions.
 
 $               EOD
 $           ENDIF
diff --git a/crypto/README.sparse_array b/crypto/README-sparse_array.md
index d86a48d9e1..d86a48d9e1 100644
--- a/crypto/README.sparse_array
+++ b/crypto/README-sparse_array.md
diff --git a/crypto/engine/README b/crypto/engine/README.md
index 0f8a8fbde4..0f8a8fbde4 100644
--- a/crypto/engine/README
+++ b/crypto/engine/README.md
diff --git a/crypto/err/README b/crypto/err/README.md
index 6d2ce0cd0e..6d2ce0cd0e 100644
--- a/crypto/err/README
+++ b/crypto/err/README.md
diff --git a/crypto/objects/README b/crypto/objects/README.md
index 700f9c5e54..700f9c5e54 100644
--- a/crypto/objects/README
+++ b/crypto/objects/README.md
diff --git a/crypto/perlasm/README b/crypto/perlasm/README.md
index 59f2c95515..59f2c95515 100644
--- a/crypto/perlasm/README
+++ b/crypto/perlasm/README.md
diff --git a/crypto/property/README b/crypto/property/README.md
index b3f56cfa2f..b3f56cfa2f 100644
--- a/crypto/property/README
+++ b/crypto/property/README.md
diff --git a/demos/README b/demos/README.txt
index d2155ef973..ef48bf580f 100644
--- a/demos/README
+++ b/demos/README.txt
@@ -1,7 +1,7 @@
 NOTE: Don't expect any of these programs to work with current
 OpenSSL releases, or even with later SSLeay releases.
 
-Original README:
+Original README.md:
 =============================================================================
 
 Some demo programs sent to me by various people
diff --git a/demos/bio/README b/demos/bio/README.txt
index a36bb48a5d..a8467cda64 100644
--- a/demos/bio/README
+++ b/demos/bio/README.txt
@@ -4,4 +4,3 @@ to simplify socket programming.
 The client-conf, server-conf, client-arg and client-conf include examples
 of how to use the SSL_CONF API for configuration file or command line
 processing.
-
diff --git a/demos/certs/README b/demos/certs/README.txt
index fde832eb2f..88cf56b1f8 100644
--- a/demos/certs/README
+++ b/demos/certs/README.txt
@@ -16,6 +16,3 @@ client certificates.
 
 The script ocspquery.sh queries the status of the certificates using the
 test responder.
-
-
-
diff --git a/dev/README b/dev/README.md
index aee3fcd6af..aee3fcd6af 100644
--- a/dev/README
+++ b/dev/README.md
diff --git a/dev/release-aux/release-version-fn.sh b/dev/release-aux/release-version-fn.sh
index f0ac69fa6e..e9e1ac3850 100644
--- a/dev/release-aux/release-version-fn.sh
+++ b/dev/release-aux/release-version-fn.sh
@@ -36,7 +36,7 @@
 # OpenSSL source directory as value.
 
 get_version () {
-    eval $(git cat-file blob HEAD:VERSION)
+    eval $(git cat-file blob HEAD:VERSION.dat)
     VERSION="$MAJOR.$MINOR.$PATCH"
     SERIES="$MAJOR.$MINOR"
     TYPE=$( echo "$PRE_RELEASE_TAG" \
@@ -102,7 +102,7 @@ set_version () {
             PRE_RELEASE_TAG="$PRE_LABEL$PRE_NUM"
             ;;
     esac
-    cat > "$SOURCEDIR/VERSION" <<EOF
+    cat > "$SOURCEDIR/VERSION.dat" <<EOF
 MAJOR=$MAJOR
 MINOR=$MINOR
 PATCH=$PATCH
diff --git a/dev/release.sh b/dev/release.sh
index 7f7042fb18..770495fc93 100755
--- a/dev/release.sh
+++ b/dev/release.sh
@@ -681,7 +681,7 @@ B<release.sh> recognises both forms.
 =head1 VERSION AND STATE
 
 With OpenSSL 3.0, all the version and state information is in the file
-F<VERSION>, where the following variables are used and changed:
+F<VERSION.dat>, where the following variables are used and changed:
 
 =over 4
 
diff --git a/doc/README b/doc/README.md
index 964d879810..f6110ff488 100644
--- a/doc/README
+++ b/doc/README.md
@@ -1,5 +1,5 @@
 
-README  This file
+README.md  This file
 
 fingerprints.txt
         PGP fingerprints of authorised release signers
diff --git a/ssl/record/README b/ssl/record/README.md
index 630fe8027a..630fe8027a 100644
--- a/ssl/record/README
+++ b/ssl/record/README.md
diff --git a/ssl/statem/README b/ssl/statem/README.md
index 86cc066372..86cc066372 100644
--- a/ssl/statem/README
+++ b/ssl/statem/README.md
diff --git a/test/README b/test/README-dev.md
index 9094d9a38d..56114fdc34 100644
--- a/test/README
+++ b/test/README-dev.md
@@ -1,44 +1,46 @@
+Guidelines for test developers
+==============================
+
 How to add recipes
-==================
+------------------
 
 For any test that you want to perform, you write a script located in
-test/recipes/, named {nn}-test_{name}.t, where {nn} is a two digit number and
-{name} is a unique name of your choice.
+`test/recipes/`, named `{nn}-test_{name}.t`,
+where `{nn}` is a two digit number and
+`{name}` is a unique name of your choice.
 
 Please note that if a test involves a new testing executable, you will need to
-do some additions in test/build.info. Please refer to the section "Changes to 
-test/build.info" below.
-
+do some additions in test/build.info. Please refer to the section
+["Changes to test/build.info"](README.md#changes-to-testbuildinfo) below.
 
 Naming conventions
-=================
-
-A test executable is named test/{name}test.c
-
-A test recipe is named test/recipes/{nn}-test_{name}.t, where {nn} is a two
-digit number and {name} is a unique name of your choice.
-
-The number {nn} is (somewhat loosely) grouped as follows:
-
-00-04  sanity, internal and essential API tests
-05-09  individual symmetric cipher algorithms
-10-14  math (bignum)
-15-19  individual asymmetric cipher algorithms
-20-24  openssl commands (some otherwise not tested)
-25-29  certificate forms, generation and verification
-30-35  engine and evp
-60-79  APIs:
-   60  X509 subsystem
-   61  BIO subsystem
-   65  CMP subsystem
-   70  PACKET layer
-80-89  "larger" protocols (CA, CMS, OCSP, SSL, TSA)
-90-98  misc
-99     most time consuming tests [such as test_fuzz]
-
+------------------
+
+A test executable is named `test/{name}test.c`
+
+A test recipe is named `test/recipes/{nn}-test_{name}.t`, where `{nn}` is a two
+digit number and `{name}` is a unique name of your choice.
+
+The number `{nn}` is (somewhat loosely) grouped as follows:
+
+    00-04  sanity, internal and essential API tests
+    05-09  individual symmetric cipher algorithms
+    10-14  math (bignum)
+    15-19  individual asymmetric cipher algorithms
+    20-24  openssl commands (some otherwise not tested)
+    25-29  certificate forms, generation and verification
+    30-35  engine and evp
+    60-79  APIs:
+       60  X509 subsystem
+       61  BIO subsystem
+       65  CMP subsystem
+       70  PACKET layer
+    80-89  "larger" protocols (CA, CMS, OCSP, SSL, TSA)
+    90-98  misc
+    99     most time consuming tests [such as test_fuzz]
 
 A recipe that just runs a test executable
-=========================================
+-----------------------------------------
 
 A script that just runs a program looks like this:
 
@@ -48,21 +50,20 @@ A script that just runs a program looks like this:
 
     simple_test("test_{name}", "{name}test", "{name}");
 
-{name} is the unique name you have chosen for your test.
-
-The second argument to `simple_test' is the test executable, and `simple_test'
-expects it to be located in test/
+`{name}` is the unique name you have chosen for your test.
 
-For documentation on OpenSSL::Test::Simple, do
-`perldoc util/perl/OpenSSL/Test/Simple.pm'.
+The second argument to `simple_test` is the test executable, and `simple_test`
+expects it to be located in `test/`
 
+For documentation on `OpenSSL::Test::Simple`,
+do `perldoc util/perl/OpenSSL/Test/Simple.pm`.
 
 A recipe that runs a more complex test
-======================================
+--------------------------------------
 
 For more complex tests, you will need to read up on Test::More and
-OpenSSL::Test.  Test::More is normally preinstalled, do `man Test::More' for
-documentation.  For OpenSSL::Test, do `perldoc util/perl/OpenSSL/Test.pm'.
+OpenSSL::Test.  Test::More is normally preinstalled, do `man Test::More` for
+documentation.  For OpenSSL::Test, do `perldoc util/perl/OpenSSL/Test.pm`.
 
 A script to start from could be this:
 
@@ -89,26 +90,25 @@ A script to start from could be this:
         # test feature 2
     }
 
-
 Changes to test/build.info
-==========================
+--------------------------
 
 Whenever a new test involves a new test executable you need to do the
 following (at all times, replace {NAME} and {name} with the name of your
 test):
 
-* add {name} to the list of programs under PROGRAMS_NO_INST
+ * add `{name}` to the list of programs under `PROGRAMS_NO_INST`
 
-* create a three line description of how to build the test, you will have
-to modify the include paths and source files if you don't want to use the
-basic test framework:
+ * create a three line description of how to build the test, you