code.consxy.com Git - clnl/blob - README.md

   1 # clnl
   2
   3 This is an experiment at creating an alternate implementation of NetLogo in Common Lisp.
   4
   5 See the [wiki](https://github.com/frankduncan/clnl/wiki) for more information.
   6
   7 # Running from source
   8
   9 If you'd like to run it from source, you're going to need a few things:
  10
  11 * A copy of the clnl source (either from the [releases page](https://github.com/frankduncan/clnl/releases) or via cloning)
  12 * An implementation of sbcl with threads enabled
  13 * The following common lisp libraries (included in [deps/common-lisp](deps/common-lisp) folder)
  14   * alexandria
  15   * babel
  16   * cffi
  17   * cl-charms
  18   * cl-opengl
  19   * cl-ppcre
  20   * ironclad
  21   * mt19937
  22   * nibbles
  23   * trivial-features
  24   * strictmath
  25   * ieee-floats
  26
  27 [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
  28
  29 ```
  30 crt 10
  31 ask turtles [ fd 1 ]
  32 show random 5
  33 ask turtles [ fd 5 ]
  34 ```
  35
  36 ## Running on OSX
  37
  38 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.
  39
  40 ## Running on Windows
  41
  42 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.
  43
  44 # Running in a common lisp instance
  45
  46 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:
  47
  48 ```lisp
  49 (asdf:load-system :clnl)
  50 (clnl:run)
  51 ```
  52
  53 # Using standalone executables
  54
  55 See the [releases page](https://github.com/frankduncan/clnl/releases) for the most recent release.