Permalink
Browse files

Removed quit alias, documented commands in README

  • Loading branch information...
1 parent 3e1ece9 commit d4f5c2dbc2f1d16eb8f07ddad99868668743e408 @dbrgn committed Apr 4, 2013
Showing with 30 additions and 3 deletions.
  1. +30 −1 README.rst
  2. +0 −2 orochi/client.py
View
@@ -20,12 +20,41 @@ Python).
Usage
-----
-::
+Install::
$ pip install -r requirements.txt
+
+Start::
+
$ export EIGHTTRACKS_API_KEY='your_api_key'
$ python -m orochi.client
+Available commands (main menu)::
+
+ search:
+ Syntax: search <searchterm>
+ Search for a mix. You can then play a mix with the "play" command.
+ play:
+ Syntax: play <mix_number>
+ Play the nth mix from the last search results.
+ exit:
+ Exit the interpreter.
+ You can also use the Ctrl-D shortcut.
+
+Available commands (play mode menu)::
+
+ pause:
+ Pause or resume the playback.
+ stop:
+ Stop the playback and exit play mode.
+ skip:
+ Skip the current song.
+ status:
+ Show the status of the currently playing song.
+ volume:
+ Syntax: volume <amount>
+ Change playback volume. The argument must be a number between 0 and 100.
+
Coding Guidelines
-----------------
View
@@ -31,8 +31,6 @@ def help_exit(self):
do_EOF = do_exit
help_EOF = help_exit
- do_quit = do_exit
- help_quit = help_exit
class Client(CmdExitMixin, cmd.Cmd, object):

0 comments on commit d4f5c2d

Please sign in to comment.