From: Michael Orlitzky <michael@orlitzky.com>
Date: Tue, 24 Feb 2026 17:59:14 +0000 (-0500)
Subject: doc/README: convert to reStructuredText
X-Git-Url: https://gitweb.michael.orlitzky.com/?a=commitdiff_plain;h=3a531cd72a648968699cabc85ec51df1f1afb8fd;p=spline3.git

doc/README: convert to reStructuredText

Still a stub, but now it looks better.
---

diff --git a/doc/README b/doc/README
deleted file mode 100644
index fa4d41f..0000000
--- a/doc/README
+++ /dev/null
@@ -1,5 +0,0 @@
-Unfortunately, there's too much content in this README for me to
-maintain two versions. Please see the canonical README at,
-
-  http://michael.orlitzky.com/code/spline3.php
-
diff --git a/doc/README.rst b/doc/README.rst
new file mode 100644
index 0000000..70a10de
--- /dev/null
+++ b/doc/README.rst
@@ -0,0 +1,66 @@
+Overview
+========
+
+spline3 is a parallel implementation of the 3d interpolation scheme
+described in paper, `Local quasi-interpolation by cubic C\ :sup:`1`
+splines on type-6 tetrahedral partitions
+<https://doi.org/10.1093/imanum/drl014>`_ by Sorokina and
+Zeilfelder. It takes volumetric data as input, and allows you to CSI
+enhance it. The gaps are filled in with interpolated data.
+
+Screenshots and detailed usage info can be found on the `spline3
+homepage <https://michael.orlitzky.com/code/spline3.xhtml>`_.
+
+
+Usage
+=====
+
+.. code-block:: console
+
+  $ spline3 --depth=<depth> --height=<height> --width=<width> <input> <output>
+
+
+Examples
+========
+
+Scaled the example MRI data (included) by the default factor of
+2x. The default depth, width, and height are compatible:
+
+.. code-block:: console
+
+  $ spline3 data/mri.bin output.bin
+
+A 2d slice of that same MRI data, scaled to 8x:
+
+.. code-block:: console
+
+  $ spline3 --slice=50 --scale=8 data/mri.bin out.bmp
+
+
+Requirements
+============
+
+All dependencies are listed in the ``spline3.cabal`` file. Just use
+cabal to build it.
+
+
+Installation
+============
+
+Cabal handles the build, so do whatever you normally do to install
+cabal packages. If you just want to install it for your user,
+
+.. code-block:: console
+
+  $ runghc Setup.hs configure --user
+  $ runghc Setup.hs build
+  $ runghc Setup.hs install
+
+should do it.
+
+
+Bugs
+====
+
+Email them to me at michael@orlitzky.com, or report them on `Codeberg
+<https://codeberg.org/mjo/spline3/issues>`_