From 345d1b6e1e08ef903c4609da7bb243e046c05c66 Mon Sep 17 00:00:00 2001
From: Brent Cook <busterb@gmail.com>
Date: Tue, 9 Jun 2020 04:12:02 -0500
Subject: [PATCH] move to README.md, update platform list

---
 INSTALL     |  6 +++---
 Makefile.am |  2 +-
 README      | 35 -----------------------------------
 README.md   | 25 +++++++++++++++++++++++++
 4 files changed, 29 insertions(+), 39 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/INSTALL b/INSTALL
index af5d15c..d5fc2a5 100644
--- a/INSTALL
+++ b/INSTALL
@@ -2,8 +2,8 @@
 ----------------
 
 You will need an entropy (randomness) source.  If your OS has arc4random or
-getentropy then that is ideal. Otherwise, you can use the builtin arc4random
-implementation or the one built into LibreSSL.
+getentropy then that is ideal. Otherwise, OpenNTPD will use its builtin
+arc4random implementation, which is also part of the LibreSSL project.
 
 2. Building / Installation
 --------------------------
@@ -128,4 +128,4 @@ configuration file uses a selection of publicly accessible "pool" servers
 ------------
 
 If you experience problems compiling, installing or running OpenNTPD,
-please report the problem to the address in the README file.
+please report the problem to the address in the README.md file.
diff --git a/Makefile.am b/Makefile.am
index f70ec4c..2374f3f 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -18,7 +18,7 @@
 SUBDIRS = include compat src
 ACLOCAL_AMFLAGS = -I m4
 
-EXTRA_DIST = VERSION ntpd.conf
+EXTRA_DIST = README.md INSTALL VERSION ntpd.conf
 
 install-exec-hook:
 	@if [ ! -f "$(DESTDIR)$(sysconfdir)/ntpd.conf" ]; then \
diff --git a/README b/README
deleted file mode 100644
index fb84e2d..0000000
--- a/README
+++ /dev/null
@@ -1,35 +0,0 @@
-This is a new port of OpenBSD's native ntpd to other Unix flavours adding
-autoconf support and the necessary compatibility layer.  It is based on
-portability code from the OpenSSH and LibreSSL portable projects.
-
-OpenNTPD has a web site at http://www.openntpd.org/
-
-The current portable tree can be found at https://github.com/openntpd-portable
-
-Platform Requirements
----------------------
- - adjtime(2) and settimeofday(2) syscalls or equivalent.
- - adjfreq(2) or an equivalent compatibility function for best results
- - daemon(3), setresgid(2), setresuid(2) or equivalent
- - A working arc4random(2) implementation, OpenSSL or LibreSSL
-     (this project shares the same arc4random compatibility code from LibreSSL)
- - libtls (included with LibreSSL 2.1.4 or higher) is required for HTTPS time
-   constraint validation.
-
-At the time of writing the Portable version is known to build and work on:
-
- - OpenBSD (5.6)
- - Linux (Ubuntu 12.04, 14.04)
- - FreeBSD (9.x, 10.x)
- - NetBSD (6.1.5)
- - Solaris (10.x, 11.x)
- - Mac OS X (10.9)
-
-OpenNTPD may work on other operating systems, newer and older, but the above
-ones are tested regularly by the developer.
-
-Reports (success or otherwise) are welcome. You may report bugs or submit pull
-requests at the GitHub project: https://github.com/openntpd-portable
-
-Thanks,
-  Brent Cook <bcook at openbsd.org>.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..792a14c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+This is the portable version of OpenBSD's native Network Time Protocol daemon,
+OpenNTPD http://www.openntpd.org/
+
+## Platform Requirements
+
+ - adjtime(2) and settimeofday(2) syscalls or equivalent.
+ - adjfreq(2) or an equivalent compatibility function for best results
+ - daemon(3), setresgid(2), setresuid(2) or equivalent
+ - a working arc4random(2) implementation (this project shares the same
+   arc4random compatibility code from LibreSSL)
+ - libtls from LibreSSL 3.0+ is required for HTTPS time constraint validation.
+
+## Supported Operating Systems
+
+OpenNTPD may work on other operating systems, newer and older, but the above
+ones are tested most recently by the developer. At the time of writing,
+OpenNTPD portable is known to build and work on:
+
+ - OpenBSD (6.7)
+ - Linux (Debian 10+, Ubuntu 18.04+)
+ - FreeBSD (12+)
+ - MacOS (10.13+)
+
+Reports (success or otherwise) are welcome. You may report bugs or submit pull
+requests at the GitHub project: https://github.com/openntpd-portable