aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCamil Staps2015-05-20 16:06:32 +0200
committerCamil Staps2015-05-20 16:06:32 +0200
commit8363bf68004f715d281e31e204a5768ec97b04b4 (patch)
treedc33f6f3e7706565f2c3702884b6fba44b69ecc4 /README.md
parentMerge branch 'java-engine-only' of ../../Botleagues_old (diff)
Readme from old repo
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 15 insertions, 2 deletions
diff --git a/README.md b/README.md
index f8c7ab2..23da2cc 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,15 @@
-# Engine
-Java game controlling engine
+# Botleagues Engine
+
+The Java engine is meant to be extended to create an own game. See the `Examples` repository for some ideas.
+
+The Java engine is **not** meant to be run standalone.
+
+## Compiling
+
+Simply run:
+
+ ant
+
+This will compile the abstract GameController. You will still need to compile your own game (or one of the examples) and bots apart from this.
+
+The game engine outputs detailed debug information to stderr, and minimal output to stdout. Therefore, to discard the debug information, you can add `2>/dev/null` to the end of the command to _redirect stderr to the black hole_.