From 45d42ae040d8860e4d03fac21b51a46c3eacede8 Mon Sep 17 00:00:00 2001
From: Joseph Ferano <joseph@ferano.io>
Date: Thu, 29 Jun 2023 16:31:58 +0700
Subject: [PATCH] WIP readme to see what it looks like

---
 README.md  | 66 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 README.org |  9 ++++----
 2 files changed, 71 insertions(+), 4 deletions(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..227036c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,66 @@
+# Simple FPS Rendering Engine
+
+## About
+
+The intention of this project is to learn about the intersection of 3 different
+topics; graphics, web, and functional programming. It uses Elm with WebGL to
+create a basic 3D first-person scene implementing several lower level graphics
+techniques including matrix transformations to model parent/child local
+transforms, texture mapping, and basic lighting with shaders.
+
+![alt text](screenshots/elm-fps.png "FPS Scene")
+
+
+## Update 2023
+
+It seems like one of the dependencies for this project, `Zinggi/elm-obj-loader`,
+is getting a 404. Therefore this dependency will be included in version control,
+so as long as you have Elm 0.18.0 tooling, you should be able to just run `elm
+init`.
+
+
+## Building
+
+This project is Elm 0.18.0, so you need to have that version installed.
+
+To install the binaries manually, use 
+- [Install Binaries](https://sirfitz.medium.com/install-elm-0-18-0-in-2021-3f64ce298801)
+If you want to use `npm`, you can follow this;
+- [Install with npm](https://discourse.elm-lang.org/t/downgrade-to-v18/2005/2)
+
+Note that for the `npm`, you will likely need an older version of Node.js, so it
+is recommended to use the [Node Version Manager
+`npm`](https://github.com/nvm-sh/nvm) for that.
+
+
+## Running
+
+In order to be able to load the textures and models, the website most be served
+by an HTTP server because of browser security, see
+[SOP](https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy)
+and [CORS](https://developer.mozilla.org/en-US/docs/Glossary/CORS) if curious.
+
+If you have Python 3 installed, simply run `python3 -m http.server`
+
+
+Then open up Either open up `Scene.html`, or use the command `elm-reactor`, if you want to be
+able to modify the source file and compile;
+
+You can walk around the scene with simple FPS controls. Open `scene.html` with
+an HTTP server, you can use the following;
+
+## Controls
+
+- Look Around: `Mouse`
+
+- FPS Movement: `WASD`
+
+- Robot Movement: `◀ ▼ ▲ ▶`
+
+- Rotate Robot: `N and M`
+
+- Rotate Robot Arm: `Y and H`
+
+- Rotate Robot Hand: `U and J`
+
+
diff --git a/README.org b/README.org
index fbd99c2..3f01fa9 100644
--- a/README.org
+++ b/README.org
@@ -1,9 +1,10 @@
-### FPS Scene
+* FPS Scene
 
 You can walk around the scene with simple FPS controls.
 Open `scene.html` with an http server, you can use the following;
 
-```python3 -m http.server 8000```
+
+python3 -m http.server
 
 Unfortunately, elm-reactor has issues with loading obj files so that's why the
 python server is needed.
@@ -11,7 +12,7 @@ python server is needed.
 ![alt text](screenshots/elm-fps.png "FPS Scene")
 
 
-##### Controls
+* Controls
 
 Mouse - Look Rotation
 
@@ -26,7 +27,7 @@ Y and H - Rotate robot arm up and down
 U and J - Rotate robot hand up and down
 
 
-### PQTorusknot
+* PQTorusknot
 
 Either open up `torus.html`, or use the command `elm-reactor`, if you want to be able to modify the source file and compile;