From 354ed1a1b72bb9b665a75c79195b3b4f043334f5 Mon Sep 17 00:00:00 2001
From: Joseph Ferano <joseph@ferano.io>
Date: Tue, 15 Aug 2023 13:14:29 +0700
Subject: [PATCH] First README revision

---
 README.org | 56 ++++++++++++++++++++++++++++++------------------------
 1 file changed, 31 insertions(+), 25 deletions(-)

diff --git a/README.org b/README.org
index fbd99c2..fe8cb2c 100644
--- a/README.org
+++ b/README.org
@@ -1,32 +1,12 @@
-### FPS Scene
+#+OPTIONS: toc:nil
 
-You can walk around the scene with simple FPS controls.
-Open `scene.html` with an http server, you can use the following;
+* PQ Torus Knot
 
-```python3 -m http.server 8000```
+** About
 
-Unfortunately, elm-reactor has issues with loading obj files so that's why the
-python server is needed.
+[[https://ferano.io/3d-fp/][Live Link]]
 
-![alt text](screenshots/elm-fps.png "FPS Scene")
-
-
-##### Controls
-
-Mouse - Look Rotation
-
-WASD - Player movement
-
-◀ ▼ ▲ ▶ - Move the Robot
-
-N and M - Rotate robot left and right
-
-Y and H - Rotate robot arm up and down
-
-U and J - Rotate robot hand up and down
-
-
-### PQTorusknot
+This is an attempt to implement the [[https://en.wikipedia.org/wiki/Torus_knot][PQ Torus Knot]] in the Elm programming language.
 
 Either open up `torus.html`, or use the command `elm-reactor`, if you want to be able to modify the source file and compile;
 
@@ -37,3 +17,29 @@ Alternatively, here's the Ellie link
 https://ellie-app.com/vVTgpBj77ra1
 
 ![alt text](screenshots/elm-knot.png "PQ Torus Knot")
+
+** Showcase
+
+** Building with Elm 0.18.0
+To install the binaries manually, follow this short guide; - [[https://sirfitz.medium.com/install-elm-0-18-0-in-2021-3f64ce298801][Install Binaries]]
+
+If you want to use =npm= instead; - =npm install -g elm@elm0.18.0=
+
+If you use =npm=, note that you will likely need an older version of Node.js, so
+it is recommended to use [[https://github.com/nvm-sh/nvm][nvm]] for that. I have not attempted this method
+personally, fyi.
+
+Once you have the Elm compiler, go ahead and run
+
+=elm make Torus.elm=
+
+And that should first pull in all the dependencies then generate an =index.html=
+file.
+
+Alternatively, you can use ~elm-reactor~, run the command and open up your browser
+to ~https://localhost:8000~ and then click on ~Torus.elm~ in the nice project
+webview provided.
+
+** License
+This project is licensed under the terms of the MIT license. For more
+information, see the included LICENSE file.