From 144d82fd6354772160cfe45a9ff09a3e142417bb Mon Sep 17 00:00:00 2001 From: Fabian Date: Thu, 12 Mar 2015 16:15:54 +0100 Subject: [PATCH] Update Readme.md --- Readme.md | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/Readme.md b/Readme.md index 8da28f9..b05297a 100644 --- a/Readme.md +++ b/Readme.md @@ -1,12 +1,25 @@ -#Marble Race Game +![Saxum Logo](https://github.com/Faerbit/Saxum/blob/master/logo/saxum_logo_small.png) -This will be a Marble Race Game developed for the Softwarepraktikum at the RWTH Aachen. +This is a Marble Puzzle/Exploration Game developed in the practical course +at the institute for Computer Graphics and Multimedia at the RWTH Aachen. + +##Downloads +See [release page](https://github.com/Faerbit/Saxum/releases) for downloads. + +##Controls +You can control the camera by moving the mouse. You can zoom with the mouse wheel. +The marble is controlled via the W,A,S and D keys. +To exit the game press escape. +The controls are also listed listed on the loading screen. ##Building Currently only tested on Linux. To build execute build.sh. Resulting binary will be in binaries. You can also use the run.sh script to directly start the binary after building it. -##Control +## OS X support +In theory this should also compile on OS X. Since I do not own a Mac it is impossible for me to test this. +If you get it compiling, please get in touch with me afterwards. -You can control the camera by moving the mouse. You can zoom with the mouse wheel. -The marble is controlled via the W,A,S and D keys. +##Modding +In theory the game is highly moddable. If you're interested in this, please get in touch with me, +so I can explain the workflow to you.