summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md48
1 files changed, 33 insertions, 15 deletions
diff --git a/README.md b/README.md
index 1c201c3..a1683c2 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@ Visualize and experiment with Chaos Equations and Strange Attractors.
This repo consists of a fork of [this repository](https://github.com/orfeasliossatos/Coding-Projects) which was tweaked and ported to Linux.
-[Video demonstration](https://youtu.be/idpOunnpKTo?si=GenFkDGUzg6Co1Zy) (from the original creator): https://youtu.be/idpOunnpKTo?si=GenFkDGUzg6Co1Zy
+[Video demonstration](https://youtu.be/idpOunnpKTo?si=GenFkDGUzg6Co1Zy) (from the [original creator](https://github.com/orfeasliossatos))
## Requirements
@@ -12,20 +12,38 @@ This project uses SFML. You may easily find SFML and SFML-devel in your package
## Usage
-Run `./run.sh` to compile and execute the program.
+To compile and execute the program do:
-### Controls
-
-H to switch to the next attractor
-
-W/A/S/D for moving in the plane
-
-Space/Shift to move up and down
+```bash
+./run.sh
+```
-Up/Down/Left/Right to turn the camera
-
-These will feel familiar to Minecraft players ;)
-
-### Todo:
+### Controls
-Pick a font that every distro ships.
+Intuitive "Minecraft" controls. "H" and "h" act the same.
+
+> W/A/S/D for moving in the plane
+>
+> Space/Shift to move up and down
+>
+> Up/Down/Left/Right to turn the camera
+
+Or as [AnonymoZ](https://github.com/AnonymoZ) put it:
+
+> Move to the next attractor with “H” and to the previous attractor with “G”.
+>
+> Press “Page Up” and “Page Down” now to control the speed of the motion.
+>
+> Use the Arrow Keys, “W, A, S, D” and also “LShift and Space” to move the camera.
+>
+> The Arrow Keys will only tilt the camera angle, while “LShift”, “Space”, “A” and “D” move “↑”, “↓”, “←”, “→” respectively.
+>
+> And finally “W” and “S” zoom in and out of the canvas.
+>
+> Press “Esc” to exit the program.
+>
+> Change to fullscreen or not with “F”.
+
+### Cool thing
+
+![Image](https://cdn.discordapp.com/attachments/663775769293750302/1148043114414620753/image.png)