From ffaa4ed7c82335d04fadbe80dbea2644d53bd256 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Th=C3=A9ophile=20Bastian?= Date: Wed, 14 Feb 2018 16:55:42 +0100 Subject: [PATCH] Add instructions to README.md --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index 10d419d..e4ac75a 100644 --- a/README.md +++ b/README.md @@ -8,3 +8,33 @@ A jelly-like ball bounces around. | [Slides](https://tobast.fr/m2/graphics/jelly.pdf) +## Compiling + +The basic compilation is achieved by a simple `make`. + +You can add additional compilation flags with `ADD_FLAGS="..." make`. + +The produced binary is `./bounce.bin` + +## Compilation flags + +* `-DDEBUG_DISPLAY_WIREFRAME`: display the wireframe of meshes +* `-DDEBUG_DISPLAY_NORMAL`: display the computed normal vectors for each + vertice +* `-DMC_SHOW_PERF`: display Marching Cubes performance stats + +## Run flags + +* `-perlin`: replace flat ground by perlin noise +* `-qwerty`, `-azerty`: change the used keymap + +For instance, `./bounce.bin -perlin -qwerty` will use perlin floor and a qwerty +keymap. + +## In-app commands + +* space: play/pause +* <, >: slow down/speed up animation +* 0: reset to default speed +* w, a, s, d (z, q, s, d in azerty): move camera +* q, e (a, e in azerty): rotate camera around y axis