Add instructions to README.md

This commit is contained in:
Théophile Bastian 2018-02-14 16:55:42 +01:00
parent 3d0f723016
commit ffaa4ed7c8

View file

@ -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