Replace README with new README.md
authorMartin Lambers <marlam@marlam.de>
Mon, 26 Aug 2019 12:16:24 +0000 (14:16 +0200)
committerMartin Lambers <marlam@marlam.de>
Mon, 26 Aug 2019 12:16:24 +0000 (14:16 +0200)
README [deleted file]
README.md [new file with mode: 0644]

diff --git a/README b/README
deleted file mode 100644 (file)
index 80f79ed..0000000
--- a/README
+++ /dev/null
@@ -1,5 +0,0 @@
-All mapping methods are implemented in the included libproj library.
-No external libraries are required.
-
-The analysis methods are grouped into disk-square methods and sphere-map
-methods. The pngvis and pdfplot modules require Qt.
diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..f7a6ed7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# mappings-sphere-disc-square
+
+This is source code originally written for the paper
+
+[M. Lambers, Mappings between sphere, disc, and square. In Journal of Computer Graphics Techniques (JCGT), 5(2), 2016, pages 1-21](http://jcgt.org/published/0005/02/01/)
+
+All mapping methods between sphere, disc, and square are implemented
+in the included libproj library. No external libraries are required.
+
+The analysis methods are grouped into disk-square methods and sphere-map
+methods. The pngvis and pdfplot modules require Qt.