INSTALL

   1                                                              -*- outline -*-
   2
   3 * Anatomy of the tarball
   4
   5 The Clon distribution has the following shape:
   6
   7 ./src/          ;; source directory
   8 ./sbcl/         ;; SBCL grovel module
   9 ./clisp/        ;; cffi grovel module for CLISP
  10 ./share/        ;; data files
  11 ./doc/          ;; documentation
  12 ./demos/        ;; demo programs
  13 ./emacs/        ;; Emacs edition utilities for Clon
  14
  15 * Portability
  16 Clon currently works on Unix systems (MacOS X included) with SBCL, CMUCL
  17 (20b), CCL, ECL, CLISP and ABCL (0.24.0). Clon has no mandatory dependency.
  18 CFFI may optionally be used with CLISP. See section A.1 of the user manual for
  19 more information.
  20
  21
  22 * Configuration
  23 Edit Makefile.cnf to your specific needs. For ASDF 1, the demo programs
  24 demos/simple.lisp and demos/advanced.lisp might also need some tweaking.
  25
  26
  27 * Pre-installation
  28
  29 If you're using ASDF 1, you need to "make install-system" before anything else
  30 in order to create the system file symlink where appropriate. Otherwise (ASDF
  31 2), we assume that you have unpacked somewhere in the source registry.
  32
  33
  34 * Build
  35
  36 Type "make" to compile the demo programs and the documentation (end-user and
  37 user manuals). A side effect of this is to also compile the library for the
  38 Lisp implementation you chose. By default, the documentation is built in info,
  39 PDF and HTML formats. If you want other formats (DVI and PostScript are
  40 available), type "make all-formats". You can also type individually "make dvi"
  41 and/or "make ps" in order to get the corresponding format.
  42
  43 In addition to the end-user and user manuals, you can generate a reference
  44 manual for Clon. In order to do that, you need to have Declt installed (see
  45 http://www.lrde.epita.fr/~didier/software/lisp/misc.php#declt), and SBCL since
  46 Declt is currently an SBCL-only library (this dependency is why the reference
  47 manual is not built by default). SBCL need not be your preferred Lisp
  48 implementation in Makefile.cnf, but you need to have it properly configured
  49 there.
  50
  51 To generate the reference manual, type "make ref". As for the rest of the
  52 documentation, "make ref" compiles the reference manual in info, PDF and HTML
  53 formats. If you want other formats (DVI and PostScript are available), type
  54 "make all-formats-ref". You can also individually type "make dvi-ref" and/or
  55 "make ps-ref" in order to get the corresponding format only.
  56
  57
  58 * Installation
  59
  60 Type "make install" to install both the documentation and the data files. If
  61 you have compiled the documentation in DVI and PostScript format, those will
  62 be installed as well. The same goes for the reference manual.
  63
  64 The demo programs are not installed anywhere.
  65
  66
  67 * Uninstallation
  68
  69 Type "make uninstall".