From ad5bbbb8f4f7ca5f07b4e1f72491755114363726 Mon Sep 17 00:00:00 2001
From: Marcin Chrzanowski <marcin.j.chrzanowski@gmail.com>
Date: Thu, 14 Nov 2019 20:23:38 +0100
Subject: Add README

---
 .gitignore |  2 --
 README.md  | 23 +++++++++++++++++++++++
 2 files changed, 23 insertions(+), 2 deletions(-)
 create mode 100644 README.md

diff --git a/.gitignore b/.gitignore
index 14981e0..1b6985c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,5 +3,3 @@
 
 # Ignore Gradle build output directory
 build
-
-*.class
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`.
-- 
cgit v1.2.3