INSTALL

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