aboutsummaryrefslogtreecommitdiff
path: root/client/readme.md
diff options
context:
space:
mode:
authorlonkaars <loek@pipeframe.xyz>2024-05-22 19:32:21 +0200
committerlonkaars <loek@pipeframe.xyz>2024-05-22 19:32:21 +0200
commit53d27ebf10225274a50dc4a7c2343d4efce55a8a (patch)
treebdf1a5d9b3900d86a999bc396e7815bd7372a549 /client/readme.md
parentdb8906d54cd9afbc57f0b40a0d618335c552f704 (diff)
clean up command handling
Diffstat (limited to 'client/readme.md')
-rw-r--r--client/readme.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/client/readme.md b/client/readme.md
new file mode 100644
index 0000000..9d755aa
--- /dev/null
+++ b/client/readme.md
@@ -0,0 +1,14 @@
+# puzzle box client
+
+goal (in order of implementation):
+```
+(pbc) help
+ exit exit pbc
+ test send a test puzbus message
+ help show this help
+ send <addr> <data> [debug] send raw message
+ status show global puzzle box state (main controller state)
+ reset reset entire game state
+ ls list connected puzzle modules
+```
+