contrib/asdf/README

   1 ASDF: Another System Definition Facility
   2 ========================================
   3
   4 Quick Summary
   5 -------------
   6
   7   1- Build it with::
   8
   9         make
  10
  11
  12   2- Make sure you put it under a path registered by the source-registry,
  13     if that isn't the case yet (see the manual). One place would be::
  14
  15         ~/.local/share/common-lisp/source/asdf/
  16
  17
  18 What is ASDF?
  19 -------------
  20
  21 ASDF is the de facto standard build facility for Common Lisp.
  22
  23 If you come from the C/C++ world, the function ASDF covers a bit of what
  24 each of make, autoconf, dlopen and libc do for C programs:
  25 it orchestrates the compilation and dependency management,
  26 handles some of the portability issues, dynamically finds and loads code,
  27 and offers some portable system access.
  28 Except everything is different in Common Lisp, and ultimately much simpler,
  29 though it requires acquiring some basic concepts.
  30 Importantly, ASDF builds all software in the current Lisp image.
  31
  32 To use ASDF, read our manual::
  33
  34     http://common-lisp.net/project/asdf/asdf.html
  35
  36 The first few sections, Loading ASDF, Configuring ASDF and Using ASDF,
  37 will get you started as a simple user.
  38 If you want to define your own systems, further read the section
  39 Defining systems with defsystem.
  40
  41 The manual is also in the doc/ subdirectory, and can be prepared with::
  42
  43     make doc
  44
  45
  46 ASDF 3 now includes an extensive runtime support library:
  47 UIOP, the Utilities for Implementation- and OS- Portability.
  48 Its documentation unhappily lies mainly in the source code and docstrings.
  49 See uiop/README for an introduction.
  50
  51 More information and additional links can be found on ASDF's home page at::
  52
  53     http://common-lisp.net/project/asdf/
  54
  55
  56 Building and testing it
  57 -----------------------
  58
  59 If you cloned our git repository, bootstrap a copy of build/asdf.lisp with::
  60
  61     make
  62
  63 To run all the tests on your favorite Lisp implementation $L,
  64 choose your most elaborate installed system $S, and try::
  65
  66     make t u l=$L s=$S
  67
  68
  69 Debugging tip
  70 -------------
  71
  72 To load ASDF in such a way that M-. will work, install the source code, and run::
  73
  74   (asdf:load-system :uiop) ;; loading uiop is simple
  75   (map () 'load ;; loading asdf/defsystem is tricky
  76    (mapcar 'asdf:component-pathname
  77     (asdf::required-components :asdf/defsystem :keep-component 'asdf:cl-source-file)))
  78
  79
  80 What has changed?
  81 -----------------
  82
  83 You can consult the debian/changelog for an overview of the
  84 significant changes in each release, and
  85 the git log for a detailed description of each commit.
  86
  87
  88 Last updated Wednesday, March 13th, 2014.