README

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