aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3b0fcb7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# SLAM Runner API
+
+## Running
+
+Symlink a SLAM `interpreter` binary executable in the repo root directory and run
+
+ npm ci
+ npm run dev
+
+Alternatively, use Docker:
+
+ docker-compose up