From e16ef4aaa6bca31b939d04b2cf604544d70b1c38 Mon Sep 17 00:00:00 2001
From: fjn1g13 <fjn1g13@soton.ac.uk>
Date: Mon, 27 Sep 2021 09:47:39 +0100
Subject: [PATCH] Add readme

---
 readme.md | 11 +++++++++++
 1 file changed, 11 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..5846726
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,11 @@
+# M4M Trim
+
+Unlike IVMCTrim, there is no trim implementation here; it's just a trimmed copy of the experiment files and the soures for M4M.
+
+Directories:
+ - `ExperimentGeneration`: experiment generation files, see the inner readme
+ - `M4M_MkI`: M4M itself (model, command line, plotter, etc.), see the inner readme for information
+ - `M4MDenseDev`: a (windows only) tool used for demos
+ - `M4MDenseMod`: a (windows only) tool for interrogating the MC problem mostly
+ - `M4MPlotting`: a (windows only) tool for previewing plots
+ - `NetState`: a serialisation library
\ No newline at end of file
-- 
GitLab