Get working on OSX
[clnl] / README.md
index 2fa28a6861665e65d0804af1658fa7784a877281..002a7b608e9c3b11f3bc7fda2810e8cb52e6b537 100644 (file)
--- a/README.md
+++ b/README.md
@@ -10,34 +10,44 @@ If you'd like to build it, you're going to need a few things:
 
 * An implementation of sbcl with threads enabled
 * The following common lisp libraries (included in deps/tarpit folder)
-  * cl-opengl
   * alexandria
   * babel
   * cffi
+  * cl-charms
+  * cl-opengl
+  * cl-ppcre
+  * docgen
   * ironclad
   * mt19937
   * nibbles
   * trivial-features
+  * style-checker
 * rlwrap
 
-# Running
+# Running as a program
 
-bin/nl has been added for convenience to run the netlogo instance.  Currently it bombs if you try to do anything to expressive with it.  A good test is
+bin/nl has been added for convenience to run the netlogo instance.  It boots up the ncurses command line with an opengl view.  Not very many commands are implemented, but it should alert you to that.  A good test is
 
 ```
 crt 10
 ask turtles [ fd 1 ]
 show random 5
+ask turtles [ fd 5 ]
 ```
 
+# Running in a common lisp instance
+
 If you'd like to run using your own sbcl instance, you can attach the clnl.asd file wherever you link asd files, and then use:
 
 ```lisp
 (asdf:load-system :clnl)
-(sb-thread:make-thread #'clnl-interface:run)
 (clnl:run)
 ```
 
+## Running on OSX
+
+In order to run on OSX, you may have to build your own sbcl instance with threads enabled.
+
 # Testing
 
 If you'd like to see the tests go on your system, there's a number of utilities to look at: