diff --git a/README.md b/README.md index f711c64..db6c701 100644 --- a/README.md +++ b/README.md @@ -1 +1,3 @@ -# Mesh-generation \ No newline at end of file +# 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.