summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorxAlpharax <42233094+xAlpharax@users.noreply.github.com>2023-09-02 15:41:23 +0300
committerxAlpharax <42233094+xAlpharax@users.noreply.github.com>2023-09-02 15:41:23 +0300
commit27b51e8c35e62183583a80a8689591fdbaf031f9 (patch)
treec0af7189ad3cc35bb56c912aa3a2fe99235826f5 /README.md
parentfa6df107cb0d78e708cb8457c0f7d74969156f56 (diff)
Initial migration of the project. It does work but would require some
documentation. Changes to be committed: new file: LorenzAttractor.cpp new file: LorenzAttractor.h modified: README.md new file: main.cpp new file: run.sh new file: vectormath.h
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index 55734b9..be16c4d 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,18 @@
# chaotic-attractors
Fork of https://github.com/orfeasliossatos/Coding-Projects tweaked and ported to Linux.
+
+The only requirement needed is SFML, you should be able to grab it from your package manager.
+This project uses SFML 2.5.1
+
+Run ./run.sh to compile and execute the program.
+
+Controls :
+H to switch to the next attractor
+
+W/A/S/D for moving in the plane
+
+Space/Shift to move up and down
+
+Up/Down/Left/Right to turn the camera
+
+These will feel familiar to Minecraft players ;)