Updated documentation and "expected results" within the demonstration.
[CommonLispStat.git] / README
blobb3f406769cd978649a23d95710765f8d3f0c9207
1 -*- mode: text -*-
3 ===========
5 See Doc/README* for history and design considerations
6 See Doc/INSTALL for getting this to work and run
8 ===========
10 For a fast start: 
12 run a common lisp (SBCL, CMUCL, CLISP) starting in the current
13 directory.   We also assume that a recent version of CFFI has been
14 installed and is ASDF-loadable.  Probably should include a local copy
15 just in case.
17 Step through ls-demo.lisp for a range of examples that will become
18 part of the test suite.
21 So basically ..   
23 1. change directory into the CommonLispStat working directory.
24 2. start your lisp
25 3. follow the commands in the ls-demo.lisp file, i.e.
27    a. (load "init.lisp")
28    b. (in-package :ls-user)
29    c. (normal-rand 20)
30    d. (setf mytest (normal-rand 20))
32    and see if they work (basic CFFI functionality for external C
33    library, LIFT package for unit-testing framework to ensure run time
34    stability).
36 4. Tell me ( <blindglobe@gmail.com> ) if there is any thing wrong (or
37    if anything happens to work.
40 What to expect:
42 CMUCL and SBCL work justfine at this stage.
44 CLISP is finicky regarding the problems that we have with CFFI
45 conversation.  In particular that we can not really do typing that we
46 need to take care of.