README.md

   1 -*- markdown -*-
   2
   3 * Compilation IOlib requires a C library named LibFixPOSIX -
   4 https://github.com/sionescu/libfixposix - and its headers in order to
   5 compile. LibFixPOSIX can either be installed manually, for which there
   6 are instructions in the source code, or through distro repositories.
   7
   8 As of Debian 9.0 Stable, the libfixposix package uses code from 2011,
   9 which is incompatible with the current IOlib and will cause a SEGFAULT
  10 on load. Don't use it.
  11
  12 * Tests
  13  Some of the socket tests require an echo server, the default being
  14 one on the Internet. If you can't use that, set
  15 iolib-tests:*echo-address* and iolib-test:*echo-port* appropriately to
  16 point the echo tests somewhere else.
  17
  18 * Generating documentation
  19  To generate the documentation, use this patched version of
  20 texinfo-docstrings: http://gitorious.org/iolib/texinfo-docstrings
  21 Then make sure that IOLib's .asd files and texinfo-docstrings.asd can
  22 be loaded and run GNU make inside doc/ ; you'll then find the
  23 generated docs under manual/. This procedure has only been tested
  24 with SBCL.