From 6e538a6bf89f6e4ac945023f7340a8f3f7734cb6 Mon Sep 17 00:00:00 2001 From: Andreas Erhard Date: Fri, 4 Aug 2017 12:21:09 +0000 Subject: [PATCH] Update README.rst --- README.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.rst b/README.rst index 1375c80..4ce90ab 100644 --- a/README.rst +++ b/README.rst @@ -59,3 +59,28 @@ Production For production deployment Apache (or other webservers like nginx, lighttpd etc.) should be used. For Apache a sample configuration is provided in the folder `apache` which can be adapted. + +Please keep in mind that you may have to adjust the path to the sound files in your apache config in order to enable local playback on the clients. + +Usage +===== + +Users can browse the webinterface, search for sounds and play them on the remote server or their local browser. + +Additionally to the normal point and click usage there are also several keyboard shortcuts available. + +Keyboard shortcuts +------------------ + +- Navigation items, input fields and sound buttons can be selected by using tab and shift+tab +- esc clears the search field +- enter plays the selected sound +- ctrl+k and ctrl+c kill all sounds +- ctrl+x switches between local and remote playback +- ctrl+enter kills sounds before the selected gets played + + +Live version +============ + +A list of sound requests and already added sounds can be found here: https://pad.wiai.de/p/soundboardTodos \ No newline at end of file