aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authortomsmeding <tom.smeding@gmail.com>2017-03-23 09:25:29 +0100
committertomsmeding <tom.smeding@gmail.com>2017-03-23 09:25:29 +0100
commitec00e242720f087b6b1059ce6087e78322e3ebdc (patch)
tree89a19f0d24671745394f9793a9a4d68b7038c7d1
parentbcaed97d55d753be16f31e2fee676fbc603e8999 (diff)
Add README
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ae6a358
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+Mocobor
+=======
+
+This is a re-implementation of the [RoboCom language][robocom], supporting the
+Classic instruction set. It is made to suit the developer instead of the mouse
+fanatic that the official simulator seems to be focusing on.
+
+This repository includes a command-line simulator (`sim`), which is most
+mature, and a GUI (`gui`) that isn't even workable yet. The `Makefile` by
+default builds both, but e.g. the command-line simulator can be built using
+`make sim`.
+
+The code should be cross-platform, in that it should build without problems on
+Linux, OS X/macOS and Windows with Cygwin. It might also work on Windows with
+MinGW. YMMV.
+
+
+[robocom]: http://robocom.rrobek.de