aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJan Tuomi <jans.tuomi@gmail.com>2022-02-11 16:49:37 +0200
committerJan Tuomi <jans.tuomi@gmail.com>2022-02-11 16:49:37 +0200
commit16e06997f8a59d12886e03637c24a54534a6135d (patch)
treeee775f3bd00e9d6613e03bbb994b13c5ff475f8e /README.md
parent2cf0c5516a5693c534032fff9c9e9fb94d9f8e14 (diff)
Add READMEHEADmain
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