[add] readme, installation and how-to on running examples

1 files changed, 34 insertions, 0 deletions

diff --git a/README.org b/README.org
index ac97d48..2bad021 100644
--- a/README.org
+++ b/README.org
@@ -6,5 +6,39 @@
 :     [1913 Webster]
 
 /A Sprite System in Common Lisp for Games and GUIs/
+** Installation 
 
+Ensure that sdl2 is installed on your system.
 
+*** Fetch Systems That Are Not In Quicklisp 
+  #+begin_src shell
+  mkdir ~/wheelwork-playground
+  cd ~/wheelwork-playground 
+  git clone https://cicadas.surf/cgit/colin/hyperquirks.git/ hyperquirks
+  git clone https://cicadas.surf/cgit/colin/lambda-riffs.git/ lambda-riffs 
+  git clone https://cicadas.surf/cgit/colin/wheelwork.git wheelwork
+  #+end_src
+
+*** Fire up Slime 
+
+You'll want to let quickisp know about the =wheelwork-playground= directory 
+
+#+begin_src lisp 
+
+(pushnew #P"~/wheelwork-playground/" ql:*local-project-directories*)
+(ql:register-local-projects )
+(ql:quickload :wheelwork)
+
+#+end_src
+
+Then load one of the example files and call its "start" function:
+
+#+begin_src lisp
+
+(load "~/wheelwork-playground/examples/02-bitmap-display.lisp")
+(ww.examples/2:start)
+
+#+end_src
+
+For example two, try clicking around, rolling your mouse wheel,
+pushign arrow keys. See the file for more about controls.