Author: abaine Date: Wed Jul 11 11:48:37 2007 New Revision: 85

Modified: trunk/funds/README Log: Better instructions for installation and running test suites.

Modified: trunk/funds/README ============================================================================== --- trunk/funds/README (original) +++ trunk/funds/README Wed Jul 11 11:48:37 2007 @@ -1,21 +1,36 @@

-Funds is designed to be loaded with asdf, available from -http://cclan.cvs.sourceforge.net/*checkout*/cclan/asdf/asdf.lisp. - -Make a symbolic link to the file funds.asd. On linux, the command -would be something like: +INSTALLING FUNDS

- prompt$ cd /somewhere/in/*central-registry* - prompt$ ln -s /path/to/funds.asd . +Funds is designed to be loaded with asdf, available from +http://cclan.cvs.sourceforge.net/*checkout*/cclan/asdf/asdf.lisp. +Make a symbolic link to the file funds/src/funds.asd somewhere visible +to asdf. On linux, the command would be:

-On my machine, that translates to: + prompt $ cd /somewhere/in/*central-registry* + prompt $ ln -s /path/to/funds/src/funds.asd .

- wonder$ cd ~/.sbcl/systems - wonder$ ln -s /home/andrew/sandbox/funds/src/funds.asd . +LOADING FUNDS

To load the system, type at a lisp prompt:

> (asdf:operate 'asdf:load-op 'funds)

-To see the publicly exported symbols in package "FUNDS," look at -the file funds/src/package.lisp. +To see the publicly exported symbols in package "FUNDS," look at the +file funds/src/package.lisp. + +RUNNING THE TESTS + +Funds' test suite uses lisp-unit, a unit test framework available from +http://www.cs.northwestern.edu/academics/courses/325/programs/lisp-unit.lisp. +Because lisp-unit is small and stable, it is included with funds. + +Make a symbolic link to funds/tests/funds-tests.asd somewhere visible +to asdf. As above, this would be: + + prompt $ cd /somewhere/in/*central-registry* + prompt $ ln -s /path/to/funds/tests/funds-tests.asd . + +Now type at a lisp prompt: + + > (asdf:operate 'asdf:load-op 'funds-tests) + > (lisp-unit:run-all-tests :funds-tests)