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 * Tests
   9  Some of the socket tests require an echo server, the default being
  10 one on the Internet. If you can't use that, set
  11 iolib-tests:*echo-address* and iolib-test:*echo-port* appropriately to
  12 point the echo tests somewhere else.
  13
  14 * Generating documentation
  15  To generate the documentation, use this patched version of
  16 texinfo-docstrings: http://gitorious.org/iolib/texinfo-docstrings
  17 Then make sure that IOLib's .asd files and texinfo-docstrings.asd can
  18 be loaded and run GNU make inside doc/ ; you'll then find the
  19 generated docs under manual/. This procedure has only been tested
  20 with SBCL.