README

   1
   2 libfiu - Fault injection in userspace
   3 -------------------------------------
   4
   5 libfiu is a C library for fault injection. It provides functions to mark
   6 "points of failure" inside your code (the "core API"), and functions to
   7 enable/disable the failure of those points (the "control API"). It's in the
   8 public domain, see the LICENSE file for more information.
   9
  10 The core API is used inside the code wanting to perform fault injection on.
  11 The control API is used inside the testing code, in order to control the
  12 injection of failures.
  13
  14 Python bindings are available in the "bindings" directory.
  15
  16
  17 Documentation
  18 -------------
  19
  20 You can find the user guide in the "doc" directory, and a manpage in the
  21 "libfiu" directory. The manpage will be installed along the library.
  22
  23 Python bindings have embedded documentation, although it's not as complete.
  24
  25
  26 Building and installing
  27 -----------------------
  28
  29 Running "make" (or "gmake") should be enough for building, and "make install"
  30 for installing. By default it installs into /usr/local, but you can provide an
  31 alternative prefix by running "make PREFIX=/my/prefix install".
  32
  33 To build the Python bindings, use "make python2"; to install them you can run
  34 "make python2_install". For the Python 3 bindings, use "make python3" and
  35 "make python3_install".
  36
  37
  38 Solaris users must use "gmake INSTALL=ginstall" instead of "make".
  39
  40
  41 Where to report bugs
  42 --------------------
  43
  44 If you want to report bugs, or have any questions or comments, just let me
  45 know at albertito@blitiri.com.ar. For more information about the library, you
  46 can go to http://blitiri.com.ar/p/libfiu.
  47
  48