aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorgretchen <gretchen@gnar.cool>2019-11-18 16:36:58 -0800
committergretchen <gretchen@gnar.cool>2019-11-18 16:37:22 -0800
commitf9b5a2cb020fb602a415d1ff2de39b7b2cc4b868 (patch)
treea94f4b7a8e522400ce7c741ff03255da608b2ddf /README.org
parent228baf459707bae2ad67029a71fbfad674d7324a (diff)
downloadnorns-etc-f9b5a2cb020fb602a415d1ff2de39b7b2cc4b868.tar.gz
norns-etc-f9b5a2cb020fb602a415d1ff2de39b7b2cc4b868.zip
Improve readme and Makefile
Diffstat (limited to 'README.org')
-rw-r--r--README.org10
1 files changed, 7 insertions, 3 deletions
diff --git a/README.org b/README.org
index 636640a..b7e273a 100644
--- a/README.org
+++ b/README.org
@@ -1,8 +1,12 @@
-* norns shell
+* norns etc
-Get a lua shell or supercollider shell on a norns from the command-line, similar to the shell in the maiden interface.
+Three scripts useful for local development on norns (i.e., outside of the ~maiden~ web interface):
-Requires nanomsg. Install with ~sudo make install~.
++ ~norns_shell~: Get a lua shell or supercollider shell on a norns from the command-line, similar to the shell in the maiden interface. This connects to the same websocket interface that ~maiden~ does.
++ ~norns_upload~: Upload a file to norns over http, just like how ~maiden~ does it.
++ ~norns_load~: Activate a norns script already on the device with ~norns.script.load(...)~ on the lua interface.
+
+~norns_shell~ requires nanomsg. Install everything with ~sudo make install~.
#+BEGIN_SRC sh
# get a lua shell