Improve README

README.md

@@ -12,10 +12,38 @@ This is a web-app to run locally while conducting a quiz (in real life) with abo
 - Download the [latest release](https://github.com/nymanjens/quizmaster/releases)
 - Unpack the archive and open a terminal in the unpacked folder
 - Run `bin/server` (UNIX) or `bin/server.bat` (Windows)
+- Browse to http://localhost:9000
 
 ## Configuration
-- `conf/application.conf`:<br>
-  Set the language and some server settings here.
 
-- `conf/quiz-config.yml`:<br>
+- `conf/application.conf`:
+    - `play.i18n.langs`: The client language, `"en"` and `"nl"` are supported
+    - `app.development.loadDummyData`: If this is true: Start with 4 teams already configured (Team A, Team B, Team C, Team D)
+
+- `conf/quiz/quiz-config.yml`:<br>
   Add your questions and answers here.
+
+## Play
+
+### Game modes
+
+This quiz can be played in different ways, which will inform the quiz settings (http://localhost:9000/app/quizsettings/*).
+
+- With up to 4 physical game controllers
+    - To choose from multiple-choice questions (in the quiz settings, choose "Answer bullet type" = Arrows). Note that these are automatically scored.
+    - To stop the timer and give an answer
+    - To indicate that a team has written down the answer on a paper so the quizmaster can continue to the answer when every team has done so
+- Via an external form, e.g. Google Docs (in the quiz settings, choose "Answer bullet type" = Characters)
+    - Go trough the round(s) first with "Show answers" = No (in the quiz settings)
+    - When everyone has submitted their answer, go back and repeate with "Show answers" = Yes
+
+### Shortcuts
+
+- `spacebar`: Pause and resume the timer
+- `left/right`: Go to the previous/next step of the question
+- `alt + left/right`: Go to the previous/next question
+- `alt + shift + left/right`: Go to the previous/next round
+- `alt + enter`: Toggle enlarged image (if there is a visible image)
+- `a`: toggle the answer to be visible in the master view (http://localhost:9000/app/master/*)
+- `1/2/3/.../0`: Increase the score of team 1, 2, ..., 10 by one point
+- `shift + 1/2/3/.../0`: Decrease the score of team 1, 2, ..., 10 by one point

conf/application.conf

@@ -1,28 +1,34 @@
 # Secret key
 # ~~~~~
-play.http.secret.key = "changeme"
+play.http.secret.key="default-secret"
 
 # The application languages
 # ~~~~~
 play.i18n.langs = ["en"]
 
+# Session configuration
+# ~~~~~
+play.http.session.maxAge = 60d
+
 # Database configuration
 # ~~~~~
 # In memory database:
 db.default.slick.profile = "slick.jdbc.H2Profile$"
 db.default.driver = org.h2.Driver
-db.default.url = "jdbc:h2:mem:test1"
+db.default.url = "jdbc:h2:mem:inmemorydb"
 db.default.connectionPool = disabled
 db.default.keepAliveConnection = true
 db.default.logStatements = true
 
 # Application-specific configuration
 # ~~~~~
-# Settings used during development only
-
-app.quiz.master-secret = "*" # "*" means the master secret is disabled
 
 # app.quiz.configYamlFilePath = "conf/demo-quiz-config.yml"
 app.quiz.configYamlFilePath = "../hydro/quizmaster/data/quiz-config.yml"
 
+# A password that protects unauthorized people from accessing the master views that contain the answers.
+# "*" means the master secret is disabled.
+app.quiz.master-secret = "*"
+
+# If this is true: Start with 4 teams already configured (Team A, Team B, Team C, Team D)
 app.development.loadDummyData = true