/[cells]/cells/README.txt
ViewVC logotype

Contents of /cells/README.txt

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.3 - (show annotations)
Sat May 20 06:32:19 2006 UTC (7 years, 11 months ago) by ktilton
Branch: MAIN
CVS Tags: HEAD
Changes since 1.2: +2 -4 lines
File MIME type: text/plain
A slow tedious transition to LLGPL
1 -*- text -*-
2
3 ***** About Cells *****
4
5 (Installation instructions follow)
6
7 Cells is a mature, stable extension to CLOS that allows you to create
8 classes, the instances of which have slots whose values are determined
9 by a formula. Think of the slots as cells in a spreadsheet (get it?),
10 and you've got the right idea. You can use any arbitrary Common Lisp
11 expression to specify the value of a cell. The Cells system takes care
12 of tracking dependencies among cells, and propagating values. It is
13 distributed under an MIT-style license.
14
15 Documentation/support is in the form of:
16
17 the cells-devel mailing list (users and developers both welcome)
18 .\docs\01-cell-basics.lisp
19 .\docs\motor-control.lisp ;; actually Bill Clementson's blog entry
20 extensive examples in the Cells-test regression test suite
21 the companion Celtk module, which happens also to provide a substantial and
22 growing portable, native Common Lisp GUI.
23
24 The above examples have all been tested against the current release of Cells.
25 Now in .\doc is cells-overview.pdf. That is pretty rough and obsolete in re the
26 code, but some of it might be enlightening.
27
28 Cells is written in portable ANSI Common Lisp. It makes very
29 light use of the introspective portions of the MOP, and contains a few
30 workarounds for shortcomings in common implementations.
31
32 Cells is known to currently work on the following Lisp implementations:
33
34 * Allegro
35 * SBCL
36 * CLISP
37 * LispWorks
38 * OpenMCL
39
40 Partially supported are:
41
42 * CMUCL
43 * Corman Lisp
44 * MCL
45
46 One of the Cells tests fails with CMUCL. This appears to be caused by
47 a bug in CMUCL's CLOS implementation, but has not been investigated in
48 great depth.
49
50 Cells is believed to work with Corman CL, but has not been recently
51 tested. In the past, MCL was supported, but a it does not currently
52 pass the test suite. Ressurecting full support for any of these
53 implementations should be easy.
54
55 Porting Cells to an unsupported but ANSI-conforming Lisp
56 implementation should be trivial: mostly a matter of determining the
57 package where the MOP lives. In reality, however, you might have to
58 find workarounds for bugs in ANSI compliance.
59
60 ***** Installation *****
61
62 [ Cells follows the usual convention for asdf and asdf-installable
63 packages. If you know what that means, that's all you need to
64 know. ]
65
66 Installation is trivial for asdf-install users:
67
68 (asdf-install:install :cells)
69
70 Users without asdf-install will need to download the distribution from
71 common-lisp.net. If your implementation does not come with ASDF,
72 please complain to the implementor, then load the asdf.lisp file
73 included in the Cells distribution.
74
75 Unpack the distribution where you will.
76
77 Unix users: If you do not already have an asdf central registry,
78 create a directory calld asdf-registry under your home directory and
79 push this onto asdf:*central-registry*. Create symlinks there to the
80 cells.asd and cells-test.asd files in the distribution. Alternately,
81 follow the instructions for Windows users.
82
83 Windows and Classic Mac users: Push the directory where you unpacked
84 the Cells distribution onto asdf:*central-registry*.
85
86 You can now load Cells in the usual manner for asdf.
87
88 SLIME:
89
90 ,load-system cells
91
92 SBCL:
93
94 (require :cells)
95
96 Other systems:
97
98 (asdf:oos 'asdf:load-op :cells)
99
100 You may wish to run the test suite. To do so, use asdf to load the
101 :cells-test system.

  ViewVC Help
Powered by ViewVC 1.1.5