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 for Clon
  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 and
  44 user manuals). A side effect of this is to also compile the library for the
  45 Lisp implementation you chose. By default, the documentation is built in info,
  46 PDF and HTML formats. If you want other formats (DVI and PostScript are
  47 available), type "make all-formats". You can also type individually "make dvi"
  48 and/or "make ps" in order to get the corresponding format.
  49
  50 In addition to the end-user and user manuals, you can generate a reference
  51 manual for Clon. In order to do that, you need to have Declt installed (see
  52 http://www.lrde.epita.fr/~didier/software/lisp/misc.php#declt), and SBCL since
  53 Declt is currently an SBCL-only library (this dependency is why the reference
  54 manual is not built by default). SBCL need not be your preferred Lisp
  55 implementation in Makefile.cnf, but you need to have it properly configured
  56 there.
  57
  58 To generate the reference manual, type "make ref". As for the rest of the
  59 documentation, "make ref" compiles the reference manual in info, PDF and HTML
  60 formats. If you want other formats (DVI and PostScript are available), type
  61 "make all-formats-ref". You can also individually type "make dvi-ref" and/or
  62 "make ps-ref" in order to get the corresponding format only.
  63
  64
  65 * Installation
  66 Type "make install" to install both the documentation and the data files. If
  67 you have compiled the documentation in DVI and PostScript format, those will
  68 be installed as well. The same goes for the reference manual.
  69
  70 The demo programs are not installed anywhere.
  71
  72
  73 * Uninstallation
  74 Type "make uninstall".