doc: introduce some minimalistic markdown without essential changes

The goal is to transform the standard documents

    README, INSTALL, SUPPORT, CONTRIBUTING, ...

from a pure text format into markdown format, but in such a way
that the documentation remains nicely formatted an easy readable
when viewed with an normal text editor.

To achieve this goal, we use a special form of 'minimalistic' markdown
which interferes as little as possible with the reading flow.

 * avoid [ATX headings][] and use [setext headings][] instead
   (works for `<h1>` and `<h2>` headings only).
 * avoid [inline links][] and use [reference links][] instead.
 * avoid [fenced code blocks][], use [indented-code-blocks][] instead.

The transformation will take place in several steps. This commit
introduces mostly changes the formatting and does not chang the
content significantly.

[ATX headings]:         https://github.github.com/gfm/#atx-headings
[setext headings]:      https://github.github.com/gfm/#setext-headings
[inline links]:         https://github.github.com/gfm/#inline-link
[reference links]:      https://github.github.com/gfm/#reference-link
[fenced code blocks]:   https://github.github.com/gfm/#fenced-code-blocks
[indented code blocks]: https://github.github.com/gfm/#indented-code-blocks

Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/10545)

1 files changed, 69 insertions, 56 deletions

diff --git a/README.md b/README.md
index 5bd9e13f17..b62c37b15a 100644
--- a/README.md
+++ b/README.md
@@ -1,36 +1,31 @@
+Description
+===========
 
- Copyright (c) 1998-2018 The OpenSSL Project
- Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson
- All rights reserved.
+The OpenSSL Project is a collaborative effort to develop a robust,
+commercial-grade, fully featured, and Open Source toolkit implementing the
+Transport Layer Security (TLS) protocols (including SSLv3) as well as a
+full-strength general purpose cryptographic library.
 
- DESCRIPTION
- -----------
+OpenSSL is descended from the SSLeay library developed by Eric A. Young
+and Tim J. Hudson.
 
- The OpenSSL Project is a collaborative effort to develop a robust,
- commercial-grade, fully featured, and Open Source toolkit implementing the
- Transport Layer Security (TLS) protocols (including SSLv3) as well as a
- full-strength general purpose cryptographic library.
+The OpenSSL toolkit 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.
 
- OpenSSL is descended from the SSLeay library developed by Eric A. Young
- and Tim J. Hudson.
+Overview
+========
 
- The OpenSSL toolkit 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.
+The OpenSSL toolkit includes:
 
- OVERVIEW
- --------
-
- The OpenSSL toolkit includes:
-
- libssl (with platform specific naming):
+ * **libssl**
      Provides the client and server-side implementations for SSLv3 and TLS.
 
- libcrypto (with platform specific naming):
+ * **libcrypto:**
      Provides general cryptographic and X.509 support needed by SSL/TLS but
      not logically part of it.
 
- openssl:
+ * **openssl:**
      A command line tool that can be used for:
         Creation of key parameters
         Creation of X.509 certificates, CSRs and CRLs
@@ -40,53 +35,71 @@
         Handling of S/MIME signed or encrypted mail
         And more...
 
- INSTALLATION
- ------------
+Installation
+============
 
- See the appropriate file:
-        INSTALL         Linux, Unix, Windows, OpenVMS, ...
-        NOTES.*         INSTALL addendums for different platforms
+See the appropriate file:
 
- SUPPORT
- -------
+ * [INSTALL](INSTALL): General installation instructions for all platforms
+ * Additional instructions for specific platforms
+    * [NOTES.ANDROID](NOTES.ANDROID)
+    * [NOTES.DJGPP](NOTES.DJGPP)
+    * [NOTES.PERL](NOTES.PERL)
+    * [NOTES.UNIX](NOTES.UNIX)
+    * [NOTES.VALGRIND](NOTES.VALGRIND)
+    * [NOTES.VMS](NOTES.VMS)
+    * [NOTES.WIN](NOTES.WIN)
 
- See the OpenSSL website www.openssl.org for details on how to obtain
- commercial technical support. Free community support is available through the
- openssl-users email list (see
- https://www.openssl.org/community/mailinglists.html for further details).
+Support
+=======
 
- If you have any problems with OpenSSL then please take the following steps
- first:
+See the OpenSSL website www.openssl.org for details on how to obtain
+commercial technical support. Free community support is available through the
+openssl-users email list (see
+https://www.openssl.org/community/mailinglists.html for further details).
 
-    - Download the latest version from the repository
-      to see if the problem has already been addressed
-    - Configure with no-asm
-    - Remove compiler optimization flags
+If you have any problems with OpenSSL then please take the following steps
+first:
 
- If you wish to report a bug then please include the following information
- and create an issue on GitHub:
+ - Download the latest version from the repository
+   to see if the problem has already been addressed
+ - Configure with no-asm
+ - Remove compiler optimization flags
 
-    - OpenSSL version: output of 'openssl version -a'
-    - Configuration data: output of 'perl configdata.pm --dump'
-    - OS Name, Version, Hardware platform
-    - Compiler Details (name, version)
-    - Application Details (name, version)
-    - Problem Description (steps that will reproduce the problem, if known)
-    - Stack Traceback (if the application dumps core)
+If you wish to report a bug then please include the following information
+and create an issue on GitHub:
 
- Just because something doesn't work the way you expect does not mean it
- is necessarily a bug in OpenSSL. Use the openssl-users email list for this type
- of query.
+ - OpenSSL version: output of 'openssl version -a'
+ - Configuration data: output of 'perl configdata.pm --dump'
+ - OS Name, Version, Hardware platform
+ - Compiler Details (name, version)
+ - Application Details (name, version)
+ - Problem Description (steps that will reproduce the problem, if known)
+ - Stack Traceback (if the application dumps core)
 
- HOW TO CONTRIBUTE TO OpenSSL
- ----------------------------
+Just because something doesn't work the way you expect does not mean it
+is necessarily a bug in OpenSSL. Use the openssl-users email list for this type
+of query.
 
- See CONTRIBUTING
+How to contribute to OpenSSL
+============================
 
- LEGALITIES
- ----------
+ See [CONTRIBUTING](CONTRIBUTING.md)
+
+ Legalities
+ ==========
 
  A number of nations restrict the use or export of cryptography. If you
  are potentially subject to such restrictions you should seek competent
  professional legal advice before attempting to develop or distribute
  cryptographic code.
+
+
+Copyright
+=========
+
+Copyright (c) 1998-2018 The OpenSSL Project
+
+Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson
+
+All rights reserved.