Browse Source

chore: Renaming main doc file

Matthias Ladkau 2 years ago
parent
commit
b4f801fe6e
1 changed files with 11 additions and 0 deletions
  1. 11 0
      examples/game/doc/README.md

+ 11 - 0
examples/game/doc/README.md

@@ -10,6 +10,17 @@ The game is played in a browser using EliasDB as a webserver. It supports multip
 
 See gameplay footage: [1](game-capture0.mp4) [2](game-capture1.mp4)
 
+## How to start
+
+The tutorial assumes you have downloaded EliasDB, extracted and build it. For this tutorial please execute "start.sh" in the subdirectory: examples/game
+
+After starting EliasDB point your browser to:
+```
+https://localhost:9090
+```
+
+The generated default key and certificate for https are self-signed which should give a security warning in the browser.  After accepting you should see a prompt asking for the game and the player name. In the moment only the game "main" is supported. The player name can be freely chosen.
+
 ## Design
 Conceptionally the game runs through 2 loops running in parallel to each other. One loop, called the game loop, calculates the game model in discreet time intervals using vector geometry. The other loop, called the display loop, displays the model by redrawing the current scene as fast as possible.