1 files changed, 33 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..f20662e
--- /dev/null
+++ b/README
@@ -0,0 +1,33 @@
+HS-MOUSE
+========
+
+Repo containing experimental control code for robotics. Services are
+implemented as finite state machines that communicate using the ZMQ pub/sub
+protocol.
+
+SETUP
+-----
+Use GHCUP to install specific Cabal/GHC versions:
+
+  https://www.haskell.org/ghcup/
+
+Compilation requires the following:
+
+- Cabal >= 3.12.1.0
+- GHC >= 9.10.1
+
+BUILD
+-----
+Build the project with:
+
+  $> cabal build all
+
+TEST
+----
+To check that it works, on one terminal run the "dummy-receiver" service:
+
+  $> cabal exec dummy-receiver -- -ltrace
+
+On a different terminal run the "dummy-pulser" service:
+
+  $> cabal exec dummy-pulser -- -ltrace