cpuid-0.2.1.3: README

                                                              -*-outline-*-
* README file for cpuid binding

This small Cabal package provides a Haskell binding to the "cpuid"
machine instruction on modern IA-32 processors.  

** Usage

Use

  runghc Setup.hs configure
  runghc Setup.hs build
  runghc Setup.hs install

for building and installing system-wide, or

  runghc Setup.hs configure --prefix=$HOME/haskell-modules
  runghc Setup.hs build
  runghc Setup.hs install --user

for building and installing in directory $HOME/haskell-modules.

Just import module "System.Cpuid" into your Haskell file and use

  ghc --make FILENAME

to compile your program.

The "tests" directory contains a small test program for the module and
demonstrates its usage. You may compile this program by installing with

  cabal install -fbuildExamples cpuid

There is also a C version for this test program, to test the overheads
of Haskell's FFI.

Happy Haskell hacking,
  Martin