From 3b753b77fd7c7dfcc2fe56cf48f9d0985b86c028 Mon Sep 17 00:00:00 2001
From: Thomas Steinholz <tsteinholz@yahoo.com>
Date: Fri, 6 Nov 2015 17:22:54 -0500
Subject: [PATCH] Update README.md

---
 README.md | 92 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 92 insertions(+)

diff --git a/README.md b/README.md
index 0e42408..6e29fde 100644
--- a/README.md
+++ b/README.md
@@ -11,6 +11,98 @@ To call the program you have to be using a command line (bat or shell script wor
   
 This creates `<FileName>.bak` which contains the original code you copied from [Shader Toy](https://www.shadertoy.com/) and changes to contents of `<FileName>` to have the GLSL that can be easily used by [LÖVE ](https://love2d.org/).
 
+# Quick Guide
+Here is a quick guid / demo using the software and how to implent it in love.
+
+### Step 1 : Go Shopping
+Go to [Shader Toys](https://www.shadertoy.com/) and pick out a shader you would like to implement. For this demo,
+I chose [This Shader](https://www.shadertoy.com/view/Mss3WN).
+
+![alt text](https://raw.githubusercontent.com/tsteinholz/LoveShaderConverter/master/docs/imgs/step-1.png "Step 1")
+
+### Step 2 : Copy the Source
+
+Of coure keep in mind licenses and do-not steal code. Only when a license permits you to, copy-and-paste the
+entirety of the code.
+
+![alt text](https://raw.githubusercontent.com/tsteinholz/LoveShaderConverter/master/docs/imgs/step-2.png "Step 2")
+
+### Step 3 : Paste
+Simply paste your clipboard to a file and save it as something.
+
+![alt text](https://raw.githubusercontent.com/tsteinholz/LoveShaderConverter/master/docs/imgs/step-3.png "Step 3")
+
+## Step 4: Convert
+Here's the fun part. Make sure you have a download of this project somewhere you can use it, in the command line,
+in a shell script, in a bat file, somewhere put down this command.
+
+    LoveShaderConverter <FileName>
+
+Of course replace <FileName> with the atcual file name in the correct directory etc. If you mess something up, the
+application will notify you.
+
+![alt text](https://raw.githubusercontent.com/tsteinholz/LoveShaderConverter/master/docs/imgs/step-4.png "Step 4")
+
+## Step 5 : Integrate with Love 2D
+This is where the tutorial stops for you if you plan to implement anything diffrently, for this demo I am making
+a window for the sole purpose of rendering this shader and nothing else. So on that note, you need to set up a new
+Love2D project, make a `conf.lua` and `main.lua` and give the files the according methods.
+
+![alt text](https://raw.githubusercontent.com/tsteinholz/LoveShaderConverter/master/docs/imgs/step-5.png "Step 5")
+
+Lets start with our local variables. We are loading a shader so lets add
+```lua
+local shader
+```
+We are going to render the shader to a canvas
+```lua
+local canvas
+```
+The output from the conversion told us we need the time
+```lua
+local time = 0
+```
+
+Now lets implement the load function!
+```lua
+    function love.load(arg)
+        -- Load the shader from the file we generated
+        shader = love.graphics.newShader('MetaHexaBalls.glsl')
+        -- Create a new Canvas to draw to
+        canvas = love.graphics.newCanvas(800, 600)
+    end
+```
+
+Next the Update Function
+```lua    
+    function love.update(dt)
+        -- increment our pseudo time variable
+        time = dt + time;
+        -- When converting, the following variables were requested from the shader...
+        shader:send('iResolution', { love.window.getWidth(), love.window.getHeight(), 1 })
+        shader:send('iGlobalTime', time)
+        shader:send('iMouse', { love.mouse.getX(), love.mouse.getY(), love.mouse.getX(), love.mouse.getY() })
+    end
+```
+
+Last and definatly not least, the draw function
+```lua
+    function love.draw()
+      love.graphics.setCanvas(canvas)
+      love.graphics.setShader(shader)
+      love.graphics.draw(canvas)
+      love.graphics.setShader()
+      love.graphics.setCanvas()
+
+      love.graphics.draw(canvas,0,0,0,1,1,0,0)
+    end
+```
+
+### Step 6 : Hit that run button
+The moment you have been waiting for, a beautiful shader rendered by love2d. Have fun ;)
+
+![alt text](https://raw.githubusercontent.com/tsteinholz/LoveShaderConverter/master/docs/imgs/step-6.png "Step 6")
+
 ## What is missing?
  * Multi-channel support
  * Remove boost?