aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBen Winston2020-07-22 21:03:22 -0400
committerBen Winston2020-07-22 21:03:22 -0400
commitbf9fb464924118e5dd73c9fe96ca2ba08485e5b6 (patch)
treee0121e4222977ebef13e684c463d7c3a49bf0f70 /README.md
parent9e4a4403853f29fde33288ca2ebd0a33e9b5f034 (diff)
add a Makefile to make installs straightforward
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 12 insertions, 2 deletions
diff --git a/README.md b/README.md
index fa862fa..6ba4b06 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,7 @@
# roku-cli
a command line remote for Roku
+## usage
- [h]ome
- [b]ack
- [p]lay
@@ -9,6 +10,15 @@ a command line remote for Roku
- arrow keys
- enter key
- < and > (rew and ff)
-- / (enter typing mode, enter to exit)
+- / (switch to typing mode, 'enter' to exit)
-coming "soon": config file to change all that stuff
+## install
+replace the default IP address in `roku.config` with the IP address of
+the roku. then run:
+
+```
+make
+sudo make install
+```
+
+program can be started using `roku`