Update README.md

chl19041 · Mar 7, 2022 · ce3f804 · ce3f804
1 parent e07dff6
commit ce3f804
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,3 @@
-# Mesh-generation
+# Mesh-generation
+
+This is an example for generating an unstructured mesh for ADCIRC/FVCOM using [OceanMesh2D](https://github.com/CHLNDDEV/OceanMesh2D). Included are the main code (`setup.m`) and the required GIS shapefiles. The package [fvcom-toolbox](https://github.com/pwcazenave/fvcom-toolbox) is also used to output FVCOM grid files.