README

   1 -*- mode: text -*-
   2
   3 For a fast start:
   4
   5 Make the shared library liblispstat with an ANSI C compiler (only gcc
   6 tested at this point):
   7
   8        cd lib
   9        make
  10
  11 run a common lisp (SBCL, CMUCL, CLISP) starting in the current
  12 directory.  We also assume that a recent version of CFFI and LIFT have
  13 been installed and are ASDF-loadable.  Probably should include a local
  14 copy just in case.
  15
  16 (on Debian: can use CLC or SBCL approaches, i.e.  ~/.clc/systems  or
  17 ~/.sbcl/systems should contain softlinks to the lispstat, cffi, and
  18 lift ASDF files (i.e. lispstat.asd, cffi.asd, and lift.asd)).
  19
  20 Step through ls-demo.lisp for a range of examples that will become
  21 part of the test suite.
  22
  23
  24
  25 So basically ..
  26
  27 1. change directory into the CommonLispStat working directory.
  28 2. start your lisp
  29 3. follow the commands in the ls-demo.lisp file, i.e.
  30
  31    a. (load "init.lisp")
  32    b. (in-package :ls-user)
  33    c. (normal-rand 20)
  34    d. (setf mytest (normal-rand 20))
  35
  36
  37    and see if they work (basic CFFI functionality for external C
  38    library, LIFT package for unit-testing framework to ensure run time
  39    stability).
  40
  41 4. Tell me ( <blindglobe@gmail.com> ) if there is any thing wrong (or
  42    if anything happens to work.
  43
  44 CMUCL and SBCL work justfine at this stage.
  45
  46 CLISP is finicky regarding the problems that we have with CFFI
  47 conversation.  In particular that we can not really do typing that we
  48 need to take care of.
  49
  50
  51
  52 ===========
  53
  54 See Doc/README* for history and design considerations
  55 See Doc/INSTALL for getting this to work and run
  56
  57 ===========
  58
  59
  60
  61 Working on this with git:
  62
  63
  64
  65     git clone git://repo.or.cz/CommonLispStat.git
  66
  67
  68 will pull the whole repository, and create a "master" branch to work
  69 on.  Probably, you don't want to use the master branch, but more to
  70 use a topic-centric branch, so you might:
  71
  72     git checkout -b myTopicBranch
  73
  74 and then work on myTopicBranch, pulling back to the master branch when
  75 needed by
  76
  77
  78
  79     git checkout master
  80     git pull . myTopicBranch
  81
  82
  83 of course, perhaps you want to contribute to the mob branch.   For
  84 that, after cloning the repository as above, you would:
  85
  86
  87     git checkout -b mob remotes/origin/mob
  88
  89 <work, work, work... through a cycle of
  90
  91          <edit>
  92          git add <files just edited>
  93          git commit -m "what I just did"
  94
  95  ad-nauseum.  When ready to commit, then just >
  96
  97          git push git+ssh://mob@repo.or.cz/srv/git/CommonLispStat.git mob:mob
  98
  99
 100
 101 and it'll be put on the mob branch, as a proposal for merging.
 102
 103 Another approach would be to pull from the topic branch into the mob
 104 branch before uploading.   Will work on a formal example soon.
 105
 106
 107 (but the basic principle is that instead of the edit cycle on mob, do
 108 something like:
 109
 110   git checkout mob
 111   git pull . myTopicBranch
 112   git push git+ssh://mob@repo.or.cz/srv/git/CommonLispStat.git mob:mob
 113
 114
 115 )