Add make setup.

cubing · Oct 22, 2024 · 770964c · 770964c
1 parent 81cbad8
commit 770964c
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/Makefile b/Makefile
@@ -2,6 +2,10 @@
 .PHONY: build
 build: build-package build-types
 
+.PHONY: setup
+setup:
+	npm install
+
 .PHONY: build-package
 build-package:
 	node script/build-package.js

diff --git a/README.md b/README.md
@@ -2,6 +2,15 @@
 
 A UI for physical scramble tables at cubing competitions.
 
+## Run the demo
+
+```shell
+git clone https://github.com/cubing/scramble-table && cd scramble-table
+make setup
+
+make dev
+```
+
 ## Example
 
 <picture>