summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIlhan Özgen Xian <iozgen@lbl.gov>2021-04-07 01:31:46 +0000
committerIlhan Özgen Xian <iozgen@lbl.gov>2021-04-07 01:31:46 +0000
commite835bd149e7780077aa6cde7074196cfb9989935 (patch)
treeae8f4baf77fa6c048d8ab83e197796ec76768d36
parent5bfb86345c9135e72c718ec673334a810251e9f9 (diff)
Add README.md
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d9ea114
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# MAMMOTH
+
+MAMMOTH is a wavelet-based multiresolution mesh generator. It leverages
+J.R. Shewchuk's {[Triangle](https://www.cs.cmu.edu/~quake/triangle.html)}
+for the Delaunay triangulation.
+
+## Dependencies
+
++ [Triangle](https://www.cs.cmu.edu/~quake/triangle.html) - A two-dimensional quality mesh generator and Delaunay triangulator
+
+## Installation
+
+Use GNU make to build the code.
+
+## Usage
+
+After building, the executable is located in the root directory.
+
+```
+./mammoth <input-file>
+```
+
+See the example input folder provided alongside the code.