add readme

byu-cxi · Aug 26, 2024 · 8f93a89 · 8f93a89
1 parent ed21740
commit 8f93a89
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,7 @@
+# BcdiDocs
+
+[![](https://img.shields.io/badge/Docs-Full-blue.svg)](https://byu-cxi.github.io/BcdiDocs/dev)
+
+## About
+
+BcdiDocs contains the documentation for a suite of julia packages that solve the BCDI problem. While these packages have their own documentation, that documentation is limited and BcdiDocs contains the full documentation. In general, this package does not need to be edited. BcdiDocs includes the packages it documents as submodules so any changes there will be reflected here after daily updates.