diff options
author | xAlpharax <42233094+xAlpharax@users.noreply.github.com> | 2023-09-02 21:59:01 +0300 |
---|---|---|
committer | xAlpharax <42233094+xAlpharax@users.noreply.github.com> | 2023-09-02 21:59:01 +0300 |
commit | 55b7ecc50187f3039bf747c04b68601dfda45a6b (patch) | |
tree | b15c8006ddc7de649dea2fcefc3c0bc6bfb4b0ca | |
parent | 27b51e8c35e62183583a80a8689591fdbaf031f9 (diff) |
Documentation added
Changes to be committed:
modified: README.md
-rw-r--r-- | README.md | 23 |
1 files changed, 18 insertions, 5 deletions
@@ -1,12 +1,21 @@ # 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 +Visualize and experiment with Chaos Equations and Strange Attractors. -Run ./run.sh to compile and execute the program. +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 + +## Requirements + +This project uses SFML. You may easily find SFML and SFML-devel in your package manager of choice or [build it yourself](https://github.com/SFML/SFML). The original project used version 2.5.1 of SFML but newer should suffice. + +## Usage + +Run `./run.sh` to compile and execute the program. + +### Controls -Controls : H to switch to the next attractor W/A/S/D for moving in the plane @@ -16,3 +25,7 @@ Space/Shift to move up and down Up/Down/Left/Right to turn the camera These will feel familiar to Minecraft players ;) + +### Todo: + +Pick a font that every distro ships. |