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 ./share/        ;; data files
  10 ./doc/          ;; documentation
  11 ./demos/        ;; demo programs
  12
  13
  14 * Configuration
  15 Edit Makefile.cnf to your specific needs. For ASDF 1, the demo programs
  16 demos/simple.lisp and demos/advanced.lisp might also need some tweaking.
  17
  18
  19 * Pre-installation
  20
  21 If you're using ASDF 1, you need to "make install-system" before anything else
  22 in order to create the system file symlink where appropriate. Otherwise (ASDF
  23 2), we assume that you have unpacked somewhere in the source registry.
  24
  25
  26 * Build
  27
  28 Type "make" to compile the demo programs and the documentation (end-user and
  29 user manuals). A side effect of this is to also compile the library for the
  30 Lisp implementation you chose. By default, the documentation is built in info,
  31 PDF and HTML formats. If you want other formats (DVI and PostScript are
  32 available), type "make all-formats". You can also type individually "make dvi"
  33 and/or "make ps" in order to get the corresponding format.
  34
  35 In addition to the end-user and user manuals, you can generate a reference
  36 manual for Clon. In order to do that, you need to have Declt installed (see
  37 http://www.lrde.epita.fr/~didier/software/lisp/misc.php#declt), and SBCL since
  38 Declt is currently an SBCL-only library (this dependency is why the reference
  39 manual is not built by default). SBCL need not be your preferred Lisp
  40 implementation in Makefile.cnf, but you need to have it properly configured
  41 there.
  42
  43 To generate the reference manual, type "make ref". As for the rest of the
  44 documentation, "make ref" compiles the reference manual in info, PDF and HTML
  45 formats. If you want other formats (DVI and PostScript are available), type
  46 "make all-formats-ref". You can also individually type "make dvi-ref" and/or
  47 "make ps-ref" in order to get the corresponding format only.
  48
  49
  50 * Installation
  51
  52 Type "make install" to install both the documentation and the data files. If
  53 you have compiled the documentation in DVI and PostScript format, those will
  54 be installed as well. The same goes for the reference manual.
  55
  56 The demo programs are not installed anywhere.
  57
  58
  59 * Uninstallation
  60
  61 Type "make uninstall".