1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..10e9c63
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# CloudAtlas
+
+## Running
+
+### API Agent
+
+    # start rmiregistry
+    ./scripts/registry
+    # start agent to bind API
+    ./gradlew runAgent
+
+### Client
+
+    ./gradlew runClient
+
+### Tests
+
+    ./gradlew test
+    # test individual components
+    ./gradlew test --tests AgentTest
+    ./gradlew test --tests InterpreterTests.fileTest13
+
+Generates an HTML test report at `build/reports/tests/test/index.html`.