# clnl
-This is an experiment at creating an alternate implementation of NetLogo mainly as an exercise for me so that I come to understand NetLogo better. It is true for me that I only truly understand something when I can explain it to someone else without repetition. In code, this manifests as expressing a program in another language.
+This is an experiment at creating an alternate implementation of NetLogo in Common Lisp.
-See the [wiki](https://github.com/frankduncan/clnl/wiki) for more information at this time.
+See the [wiki](https://github.com/frankduncan/clnl/wiki) for more information.
-# Building
+# Running from source
-If you'd like to build it, you're going to need a few things:
+If you'd like to run it from source, you're going to need a few things:
+* A copy of the clnl source (either from the [releases page](https://github.com/frankduncan/clnl/releases) or via cloning)
* An implementation of sbcl with threads enabled
-* The following common lisp libraries (included in deps/tarpit folder)
+* The following common lisp libraries (included in [deps/common-lisp](deps/common-lisp) folder)
* alexandria
* babel
* cffi
* cl-charms
* cl-opengl
* cl-ppcre
- * docgen
* ironclad
* mt19937
* nibbles
* trivial-features
- * style-checker
-* rlwrap
-# Running as a program
-
-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
+[bin/nl](bin/nl) and [bin/run.lisp](bin/run.lisp) have 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 5 ]
```
+## Running on OSX
+
+In order to run on OSX, you may have to build your own sbcl instance with threads enabled. See [bin/buildosxexec.sh](bin/buildosxexec.sh) for how it's done when releasing/testing.
+
+## Running on Windows
+
+In order to run on Windows, you will need to install a copy of 32bit sbcl with threads enabled, as well as putting a copy of freeglut and pdcurses in that directory. See [bin/buildwindowsexec.sh](bin/buildwindowsexec.sh) for how it's done when releasing/testing.
+
# 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:
(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:
+# Using standalone executables
-* bin/test.lisp
-* bin/diagnose-test
-* bin/diagnose-view-test
-* bin/test-mode
+See the [releases page](https://github.com/frankduncan/clnl/releases) for the most recent release.
projects / clnl / blobdiff