From: Raimon Grau <raimonster@gmail.com>
Date: Thu, 25 Apr 2013 22:40:34 +0000 (+0200)
Subject: added docs for newbie hackers
X-Git-Url: http://repo.macrolet.net/gitweb/?a=commitdiff_plain;h=9a9f2833b150d272adfa4f7bcf4083d7fd20b20d;p=jscl.git

added docs for newbie hackers
---

diff --git a/README.org b/README.org
index d6b5ebd..3197b14 100644
--- a/README.org
+++ b/README.org
@@ -2,7 +2,7 @@
 
   JSCL is a Common Lisp to Javascript compiler, which is bootstrapped
   from Common Lisp and executed from the browser.
-  
+
 ** Getting started
 
 You can try a demo [[http://davazp.net/jscl/jscl.html][here]]. But if you want to hack JSCL, you will have
@@ -32,7 +32,7 @@ operators, functions and macros. In particular:
   - Optional and keyword arguments
   - SETF places
   - Packages
-    
+
 The compiler is very verbose, some simple optimizations or
 /minification/ could help to deal with it.
 
@@ -42,3 +42,13 @@ just enough compliant to include a [[http://www.cs.cmu.edu/afs/cs/project/ai-rep
 implementation, or even [[http://www.cs.cmu.edu/afs/cs/project/ai-repository/ai/lang/lisp/oop/0.html][CLOS]] or non-CLOS OOP.
 
 /Feel free to hack it yourself/
+
+
+** Hacking
+
+*** Newbie guide
+    - load slime from the root directory.
+    - c-c c-l jscl.lisp  to load the whole project
+    - (bootstrap) will generate jscl.js
+    - add tests
+    - open tests.html in your browser to see your failed tests