contrib/README

   1 This directory is for extensions to SBCL. They aren't necessary for
   2 core SBCL functionality, or else they'd be built into the main SBCL
   3 binary automatically. And they're not portable Common Lisp, or they'd
   4 be put elsewhere (see http://sbcl.sf.net/libs.php for pointers)
   5
   6 There are two kinds of contrib module in this directory:
   7
   8   * Newer contrib modules conform to the contrib standard (see
   9     STANDARDS) and are automatically built and installed along with
  10     SBCL itself.  Each of these is in its own subdirectory with a
  11     Makefile, and can be loaded with REQUIRE
  12
  13     Many of them use ASDF, so you have to require that first: e.g.
  14
  15         * (require 'asdf)
  16         * (require 'sb-bsd-sockets)
  17
  18   * Older standalone files are effectively unpackaged and may or may
  19     not work with the current SBCL version.
  20
  21 Some good candidates for future extensions here are:
  22   * bindings to existing foreign libraries (e.g. to a regexp library
  23     like PCRE, or to a compression library like zlib, or to a graphics
  24     library like Tk)
  25   * new libraries (e.g. a CORBA interface)
  26   * low-level hooks into SBCL needed to interface it to some wrapper
  27     system (e.g. to interface to a graphical debugger of some sort)
  28   * a too-alpha-to-be-supported-yet tree shaker
  29
  30 SBCL extensions of less general interest, e.g. a binding to the C
  31 interface of the Oracle RDBMS, or particularly large extensions, e.g.
  32 big graphics frameworks, can also be associated with the SBCL project,
  33 but instead of being included in this directory as part of the
  34 distribution, they will be made available or linked to on the SBCL
  35 project web site.