README: convert to reStructuredText

This is mainly for the benefit of Codeberg where links and code blocks
are nicely formatted.

diff --git a/README b/README
deleted file mode 100644 (file)
index afb09f0..0000000
--- a/README
+++ /dev/null
@@ -1,37 +0,0 @@
-valtz 0.8 - a simple tool to validate tinydns-data files
-========================================================
-
-== What is it? ==
-
-This is a fork of Magnus Bodin's simple utility to validate
-tinydns-data files. The original has not been updated in many years.
-
-== How do I install it? ==
-
-It's a Perl script, so download it and put it in your $PATH. It comes
-with a man page that can be installed to your system's $MANPATH as
-well.
-
-== How do I use it? ==
-
-Run it on your tinydns-data files. If it finds errors, it will complain:
-
-  $ valtz example.com.tinydns
-    File example.com.tinydns
-      line 1; err 32 @example.com.::127.0.0.1:
-        expected: fqdn:ip:x:dist:ttl:timestamp:lo
-        pos 2; x; IP address found where hostname expected
-  $ echo $?
-  1
-
-If it doesn't, it won't:
-
-  $ valtz example.org.tinydns
-  $ echo $?
-  0
-
-For more details, see the included man page.
-
-== How do I report bugs? ==
-
-Email them to me at michael@orlitzky.com.

diff --git a/README.rst b/README.rst
new file mode 100644 (file)
index 0000000..dea4273
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,51 @@
+valtz - CLI utility to validate tinydns-data files
+
+
+What is it?
+===========
+
+This is a fork of `Magnus Bodin's <https://x42.com/software/valtz/>`_
+tool to validate `tinydns-data
+<https://cr.yp.to/djbdns/tinydns-data.html>`_ files. It is still
+maintained, but only barely, because no one uses tinydns any more.
+
+
+How do I install it?
+====================
+
+It's a Perl script, so download it and put it in your ``$PATH``. It
+comes with a man page that can be installed to your system's
+``$MANPATH`` as well.
+
+
+How do I use it?
+================
+
+Run it on your tinydns-data files. If it finds errors, it will complain:
+
+.. code-block:: console
+
+  $ valtz example.com.tinydns
+    File example.com.tinydns
+      line 1; err 32 @example.com.::127.0.0.1:
+        expected: fqdn:ip:x:dist:ttl:timestamp:lo
+        pos 2; x; IP address found where hostname expected
+  $ echo $?
+  1
+
+If it doesn't, it won't:
+
+.. code-block:: console
+
+  $ valtz example.org.tinydns
+  $ echo $?
+  0
+
+For more details, see the included man page.
+
+
+How do I report bugs?
+=====================
+
+Email them to me at michael@orlitzky.com, or report them on `Codeberg
+<https://codeberg.org/mjo/valtz/issues>`_.