[PATCH 20/20] Rewrite README in markdown

[Mario Limonciello <mario.limonciello@amd.com>]

This will make it render more nicely if linux-firmware.git moves
to Gitlab or a fork of it is hosted in Gitlab.

Signed-off-by: Mario Limonciello <mario.limonciello@amd.com>
---
 README          | 43 ---------------------------------------
 README.md       | 54 +++++++++++++++++++++++++++++++++++++++++++++++++
 check_whence.py |  2 +-
 3 files changed, 55 insertions(+), 44 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/README b/README
deleted file mode 100644
index 77ff0106..00000000
--- a/README
+++ /dev/null
@@ -1,43 +0,0 @@
-
-	Linux firmware
-	==============
-
-  <http://git.kernel.org/?p=linux/kernel/git/firmware/linux-firmware.git>
-
-  git://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git
-
-This repository contains all these firmware images which have been
-extracted from older drivers, as well various new firmware images which
-we were never permitted to include in a GPL'd work, but which we _have_
-been permitted to redistribute under separate cover.
-
-To submit firmware to this repository, please send either a git binary
-diff or preferably a git pull request to:
-      linux-firmware@kernel.org
-and also cc: to related mailing lists.
-
-If your commit adds new firmware, it must update the WHENCE file to
-clearly state the license under which the firmware is available, and
-that it is redistributable. Being redistributable includes ensuring
-the firmware license provided includes an implicit or explicit
-patent grant to end users to ensure full functionality of device
-operation with the firmware. If the license is long and involved, it's
-permitted to include it in a separate file and refer to it from the
-WHENCE file ('See LICENSE.foo for details.').
-And if it were possible, a changelog of the firmware itself.
-
-Run 'make check' to check that WHENCE is consistent with the
-repository contents.
-
-Ideally, your commit should contain a Signed-Off-By: from someone
-authoritative on the licensing of the firmware in question (i.e. from
-within the company that owns the code).
-
-
-WARNING:
-=======
-
-Don't send any "CONFIDENTIALITY STATEMENT" in your e-mail, patch or
-request. Otherwise your firmware _will never be accepted_.
-
-Maintainers are really busy, so don't expect a prompt reply.
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..d9fb7895
--- /dev/null
+++ b/README.md
@@ -0,0 +1,54 @@
+
+# Linux firmware
+
+This repository contains all these firmware images which have been
+extracted from older drivers, as well various new firmware images which
+we were never permitted to include in a GPL'd work, but which we _have_
+been permitted to redistribute under separate cover.
+
+## URLs
+
+[HTTP](http://git.kernel.org/?p=linux/kernel/git/firmware/linux-firmware.git)
+
+[Git](git://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git)
+
+## Submitting firmware
+
+To submit firmware to this repository, please send either a git binary
+diff or preferably a git pull request to: `linux-firmware@kernel.org`
+and also cc: to related mailing lists.
+
+## Quality
+
+If your commit adds new firmware, it must update the `WHENCE` file to
+clearly state the license under which the firmware is available, and
+that it is redistributable. Being redistributable includes ensuring
+the firmware license provided includes an implicit or explicit
+patent grant to end users to ensure full functionality of device
+operation with the firmware. If the license is long and involved, it's
+permitted to include it in a separate file and refer to it from the
+`WHENCE` file (IE _'See `LICENSE.foo` for details.'_).
+And if it were possible, a changelog of the firmware itself.
+
+To maintain consistent quality on the repository, please run the following
+before submitting a patch:
+
+```shell
+make check
+```
+
+If you don't have pre-commit installed, you can install it with:
+
+```shell
+pip install pre-commit
+```
+
+Your commit **must** contain a `Signed-Off-By:` from someone authoritative on
+the licensing of the firmware in question (i.e. from within the company
+that owns the code).
+
+## Warnings
+
+1. Don't send any "CONFIDENTIALITY STATEMENT" in your e-mail, patch or
+request. Otherwise your firmware _will never be accepted_.
+2. Maintainers are really busy, so don't expect a prompt reply.
diff --git a/check_whence.py b/check_whence.py
index 3658e745..f20c0c86 100755
--- a/check_whence.py
+++ b/check_whence.py
@@ -79,7 +79,7 @@ def main():
             "check_whence.py",
             "configure",
             "Makefile",
-            "README",
+            "README.md",
             "copy-firmware.sh",
             "WHENCE",
         ]
-- 
2.25.1