commit: b76e3275817c85d1af8eff1433ef706b97659370
parent: 464f18e17938787e9b910afe159d8ee9058a9c2b
author: Brian Callahan <bcallah@openbsd.org>
date: Fri, 12 Jan 2018 23:11:25 -0500
Update README.md
1 file changed, 27 insertions(+), 14 deletions(-)
diff --git a/README.md b/README.md
@@ -4,22 +4,34 @@ Portable OpenBSD `ksh(1)`.
Why?
----
-Because other operating systems deserve a good shell to use.
-Originally a port of `ksh` to FreeBSD. The default FreeBSD shell is `tcsh`.
-DragonFly BSD should also just work.
-Later, NetBSD support was added. NetBSD also has a `ksh` variant so it might
-be less useful there.
-Linux support, tested on Slackware and Ubuntu, exists. This includes Cygwin.
-Darwin (Mac OS X) supported as well.
-Other operating system support welcome and appreciated.
+Because all operating systems deserve a good shell.
+
+Supported systems
+-----------------
+* OpenBSD
+* FreeBSD
+* DragonFly BSD
+* NetBSD
+* Mac OS X
+* Linux (glibc and musl)
+* Android (via Termux)
+
+Running on a system not listed here? Add it and send a pull request!
+
+Packages
+--------
+`oksh` is included in some package systems.
+* [FreeBSD ports](https://www.freshports.org/shells/oksh/)
+
+Using a package not listed here? Add it and send a pull request!
Dependencies
------------
A C compiler that understands the `long long` type. A C99 compiler is the
-easiest way to ensure that oksh will build correctly.
+easiest way to ensure that `oksh` will build correctly.
-A `configure` script that produces a POSIX `Makefile` is available to ease
-building and installation and can be run by:
+A `configure` script that produces a `POSIX` `Makefile` is provided to
+ease building and installation and can be run by:
```
$ ./configure
$ make && sudo make install
@@ -27,7 +39,7 @@ $ make && sudo make install
In case of emergency
--------------------
-If you cannot execute make for whatever reason, a rescue script,
+If you cannot execute `make` for whatever reason, a rescue script,
`rescue.sh`, is available. This script contains nothing more than a
hand-written list of compiler invocations which will build `oksh` in the
most basic and portable way possible. This rescue shell is perfectly
@@ -35,8 +47,9 @@ usable (as it is just an unoptimized build).
License
-------
-Most files are public domain (see LEGAL).
-The rest are BSD or ISC licensed.
+The main Korn shell files are public domain (see `LEGAL`).
+Portability files are BSD or ISC licensed; see individual file headers
+for details.
Get a tarball
-------------
