README.md in nronn-0.10.1.pre3 vs README.md in nronn-0.10.1.pre4

- old
+ new

@@ -1,7 +1,9 @@ # nRonn +[![Ruby](https://github.com/n-ronn/nronn/actions/workflows/build.yml/badge.svg)](https://github.com/n-ronn/nronn/actions/workflows/build.yml?query=branch%3Amain) + nRonn is a new, currently-maintained fork of the defunct [original Ronn project](https://github.com/rtomayko/ronn). Ronn builds manuals. It converts simple, human readable textfiles to roff for terminal display, and also to HTML for the web. @@ -12,19 +14,19 @@ detail. The `*.ronn` files found in the [`man/`][1] directory show off a wide range of ronn capabilities: -* [ronn(1)](http://rtomayko.github.com/ronn/ronn.1) command - - [source file](https://github.com/n-ronn/nronn/blob/master/man/ronn.1.ronn), - [roff output](https://github.com/n-ronn/nronn/blob/master/man/ronn.1) +* [ronn(1)](https://n-ronn.github.io/nronn/ronn.1.html) command - + [source file](https://github.com/n-ronn/nronn/blob/main/man/ronn.1.ronn), + [roff output](https://github.com/n-ronn/nronn/blob/main/man/ronn.1) -* [ronn-format(7)](http://rtomayko.github.com/ronn/ronn-format.7) - - [source file](https://github.com/n-ronn/nronn/blob/master/man/ronn-format.7.ronn), - [roff output](https://github.com/n-ronn/nronn/blob/master/man/ronn-format.7) +* [ronn-format(7)](https://n-ronn.github.io/nronn/ronn-format.7.html) - + [source file](https://github.com/n-ronn/nronn/blob/main/man/ronn-format.7.ronn), + [roff output](https://github.com/n-ronn/nronn/blob/main/man/ronn-format.7) -[1]: https://github.com/n-ronn/nronn/tree/master/man +[1]: https://github.com/n-ronn/nronn/tree/main/man As an alternative, you might want to check out [pandoc](http://johnmacfarlane.net/pandoc/) which can also convert markdown into roff manual pages. ## Installation @@ -69,11 +71,11 @@ ```bash $ man man/ronn.5 ``` -The [ronn(1)](http://rtomayko.github.com/ronn/ronn.1) manual page includes +The [ronn(1)](https://n-ronn.github.io/nronn/ronn.1.html) manual page includes comprehensive documentation on `ronn` command line options. ## Background Some think Unix manual pages are a poor and outdated form of documentation. nRonn @@ -124,8 +126,10 @@ MIT License. See [LICENSE.txt](LICENSE.txt) for detail. -## Build Status +## JRuby support -TODO +JRuby is not supported yet: + +[![JRuby](https://github.com/n-ronn/nronn/actions/workflows/jruby.yml/badge.svg)](https://github.com/n-ronn/nronn/actions/workflows/jruby.yml)