diff --git a/README.md b/README.md index 19943d1..b259247 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,17 @@ -#2D Digital Image Correlation (DIC) +# DigImCorr - 2D Digital Image Correlation (DIC) + +This package contains a MATLAB based 2D-DIC software implementation done +by ShanMukha Innovations. The following files are part of the package. + + +ReleaseNotes.md - Software release notes +LICENSE - Software license file +src/ - source files for the application +docs/ - help and user training documents +DigImCorr.mlappinstall - MATLAB app install +sampleImages/ - sample image files + +To install the application, follow the instructions given in the Instllation +section of the Help documentation. You can find the help document in +the docs folder.