From c8ff00bce7fa841d91ca1b1f48ba03bc87d2e10e Mon Sep 17 00:00:00 2001
From: Philip McCullick <philip.mccullick@nps.edu>
Date: Tue, 5 Nov 2019 13:48:12 -0800
Subject: [PATCH] Add readme.md with basic getting started info

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

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..68508a4
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,20 @@
+# Monterey Phoenix - Trace Generator
+
+
+## Setup/Requirements
+* C++ compiler
+
+## Running Event Generator
+The event generator can be run using the rall.sh script in the build folder:
+```bash
+./Code/rall.sh [mp_filepath] [scope]
+```
+- mp_filepath should be the location of the MP file that you want to process
+- scope is the number of repetitions, use higher values with caution
+
+There are example MP files in the Firebird_Pre_loaded_examples folder. To build those files, run the following command:
+```bash
+./Code/rall.sh ./Firebird_Pre_loaded_examples/Example01_simple_message_flow.mp 1
+```
+
+The output will be saved to Example01_simple_message_flow.json
\ No newline at end of file
-- 
GitLab