From 27b51e8c35e62183583a80a8689591fdbaf031f9 Mon Sep 17 00:00:00 2001
From: xAlpharax <42233094+xAlpharax@users.noreply.github.com>
Date: Sat, 2 Sep 2023 15:41:23 +0300
Subject: 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
---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

(limited to 'README.md')

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 ;)
-- 
cgit v1.2.3