From b662e55525ac6a2125f1c7eab1087813542d1900 Mon Sep 17 00:00:00 2001 From: agl Date: Mon, 21 Jan 2008 01:03:57 +0530 Subject: [PATCH] Update README.txt with details on Haskell testing/documentation etc darcs-hash:6e1ebc9c4af1cdb252325b9353a35d20d2e02185 --- zfec/README.txt | 13 ++++++++++--- zfec/haskell/{ => test}/FECTest.hs | 0 2 files changed, 10 insertions(+), 3 deletions(-) rename zfec/haskell/{ => test}/FECTest.hs (100%) diff --git a/zfec/README.txt b/zfec/README.txt index 6e4ed97..e563ab6 100644 --- a/zfec/README.txt +++ b/zfec/README.txt @@ -40,7 +40,13 @@ Python installed, you can run "trial zfec" for nicer output and test options.) This will run the tests of the C API, the Python API, and the command-line tools. -To run the tests of the Haskell API, do XYZ. +To run the tests of the Haskell API: + % runhaskell haskell/test/FECTest.hs + +Note that you must have installed the library first in order for this to work +due to the fact that the interpreter cannot process FEC.hs as it takes a +reference to an FFI function. + * Community @@ -205,7 +211,8 @@ objects (e.g. Python strings) to hold the data that you pass to zfec. ** Haskell API -XYZ +The Haskell code is fully Haddocked, to generate the documentation, run + % runhaskell Setup.lhs haddock * Utilities @@ -219,7 +226,7 @@ command-line tools from the bin/ directory. A C compiler is required. To use the Python API or the command-line tools a Python interpreter is also required. We have tested it with Python v2.4 and -v2.5. For the Haskell interface, a Haskell compiler is required XYZ. +v2.5. For the Haskell interface, GHC >= 6.8.1 is required. * Acknowledgements diff --git a/zfec/haskell/FECTest.hs b/zfec/haskell/test/FECTest.hs similarity index 100% rename from zfec/haskell/FECTest.hs rename to zfec/haskell/test/FECTest.hs -- 2.45.2