diff --git a/readme.md b/readme.md new file mode 100644 index 0000000000000000000000000000000000000000..5846726cbd9734e0ae20f5e3e36a8aaa156e0c83 --- /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