git @ Cat's Eye Technologies Falderal / 8bec116
Update README. Chris Pressey 10 years ago
1 changed file(s) with 30 addition(s) and 11 deletion(s). Raw diff Collapse all Expand all
1818 programming languages in Haskell, and wanting to write nicely formatted
1919 tests suites for them.
2020
21 Current Version
22 ---------------
21 History
22 -------
2323
24 The current version of Falderal is 0.1. The API should not be expected to
25 be stable through the 0.x series, however Test.Falderal.Runner.run is not
26 expected to change its type signature (it takes a "property list" of options,
27 although no options are currently honoured.)
24 The current released version of Falderal is 0.1. It introduced the following
25 features:
26
27 * Provision of a framework for writing and running literate tests which may
28 be embedded in literate Haskell source code.
29 * Testing Haskell functions of type String -> String. A test specifies input
30 to the function, and may expect a particular output, or that a particular
31 exception is thrown.
32 * Through simple adapters, testing functions of other types such as
33 (Show a) => String -> a.
34
35 The current version under development is 0.2. It will introduce the following
36 features:
37
38 * Improved formatting of failure reports. Multi-line input text or expected
39 output is always presented starting on its own line.
40 * Tests may be organized into groups; the entire group is preceded by some
41 literal text, but there is no literal text between the tests in the group.
42 When one of these tests fails, the literal text for the group is reported,
43 along with the number of the test within the group.
44
45 The API should not be expected to be stable through the 0.x series.
2846
2947 Development
3048 -----------
3755
3856 https://bitbucket.org/catseye/falderal/issues
3957
40 Official release distfiles may at some point be available through Falderal's
41 project page on Cat's Eye Technologies' website:
58 Official release distfiles are available on the [Falderal
59 project page][] at [Cat's Eye Technologies'][].
4260
43 http://catseye.tc/project/falderal/
61 [Falderal project page]: http://catseye.tc/projects/falderal/
62 [Cat's Eye Technologies]: http://catseye.tc/
4463
4564 For Further Information
4665 -----------------------
4766
48 Please see the Falderal wiki on Bitbucket:
67 Please see the [Falderal wiki][] on Bitbucket.
4968
50 https://bitbucket.org/catseye/falderal/wiki/
69 [Falderal wiki]: https://bitbucket.org/catseye/falderal/wiki/