README

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