Add Licensing and Contributing
[clnl] / src / main / clnl / base.lisp
1 ; Copyright 2022 Frank Duncan (frank@consxy.com) under AGPL3.  See distributed LICENSE.txt.
2 (in-package #:clnl)
3
4 (defvar *model-package* (find-package :clnl-default-model-package)
5  "*MODEL-PACKAGE*
6
7 VALUE TYPE:
8
9   a package
10
11 INITIAL VALUE:
12
13   The package named by :clnl-default-model-package
14
15 DESCRIPTION:
16
17   *MODEL-PACKAGE* is used for interning symbols as a NetLogo code
18   gets compiled.
19
20   :clnl-default-model-package is used because it's set up to shadow
21   common overlaps between the :cl package and netlogo programs, most
22   notably GO.  When you set this to a package of your choosing, be
23   aware of those overlaps in the case that use :use :common-lisp
24
25   Any local symbols are interned in this package, for use either
26   by other code, or in order to have all symbols interned in the
27   same placakge.  This is also the package in which a model should
28   be run, whether by clnl code or independently.")