Commit ac8dd122 authored by Francois-Rene Rideau's avatar Francois-Rene Rideau
Browse files

Update the README, notably to point to debian/changelog for release notes.

parent fa192c7d
Loading
Loading
Loading
Loading
+19 −6
Original line number Original line Diff line number Diff line
@@ -21,13 +21,13 @@ What is ASDF?
ASDF is the de facto standard build facility for Common Lisp.
ASDF is the de facto standard build facility for Common Lisp.


If you come from the C/C++ world, the function ASDF covers a bit of what
If you come from the C/C++ world, the function ASDF covers a bit of what
each of Make, autoconf, Make, dlopen and libc do for C programs:
each of make, autoconf, dlopen and libc do for C programs:
it orchestrates the compilation and dependency management,
it orchestrates the compilation and dependency management,
handles some of the portability issues, dynamically finds and loads code,
handles some of the portability issues, dynamically finds and loads code,
and offers some portable system access.
and offers some portable system access.
Except everything is different in Common Lisp, and ultimately much simpler,
Except everything is different in Common Lisp, and ultimately much simpler,
though it requires acquiring some basic concepts;
though it requires acquiring some basic concepts.
notably, ASDF tries to make it all happen in the current Lisp image.
Importantly, ASDF builds all software in the current Lisp image.


To use ASDF, read our manual::
To use ASDF, read our manual::


@@ -38,6 +38,11 @@ will get you started as a simple user.
If you want to define your own systems, further read the section
If you want to define your own systems, further read the section
Defining systems with defsystem.
Defining systems with defsystem.


The manual is also in the doc/ subdirectory, and can be prepared with::

    make doc


ASDF 3 now includes an extensive runtime support library:
ASDF 3 now includes an extensive runtime support library:
UIOP, the Utilities for Implementation- and OS- Portability.
UIOP, the Utilities for Implementation- and OS- Portability.
Its documentation unhappily lies mainly in the source code and docstrings.
Its documentation unhappily lies mainly in the source code and docstrings.
@@ -66,10 +71,18 @@ Debugging tip


To load ASDF in such a way that M-. will work, install the source code, and run::
To load ASDF in such a way that M-. will work, install the source code, and run::


  (asdf:load-system :uiop) ;; for uiop
  (asdf:load-system :uiop) ;; loading uiop is simple
  (map () 'load ;; for asdf/defsystem
  (map () 'load ;; loading asdf/defsystem is tricky
   (mapcar 'asdf:component-pathname
   (mapcar 'asdf:component-pathname
    (asdf::required-components :asdf/defsystem :keep-component 'asdf:cl-source-file)))
    (asdf::required-components :asdf/defsystem :keep-component 'asdf:cl-source-file)))




Last updated Wednesday, January 31st, 2014.
What has changed?
-----------------

You can consult the debian/changelog for an overview of the
significant changes in each release, and
the git log for a detailed description of each commit.


Last updated Wednesday, March 13th, 2014.