git @ Cat's Eye Technologies Falderal / 6f5335a
Update README for 0.6 release. catseye 13 years ago
1 changed file(s) with 11 addition(s) and 10 deletion(s). Raw diff Collapse all Expand all
4141 Features
4242 --------
4343
44 The current version of Falderal is described in the Falderal Literate Test
45 Format document. The current version of `Test.Falderal` is 0.5 "The Loop".
46 Neither the file format specification, nor the `Test.Falderal` API, should
47 be expected to be stable through the 0.x series.
44 The current version of Falderal is described in the [Falderal Literate Test
45 Format](docs/Falderal_Literate_Test_Format.markdown). The current version
46 of `Test.Falderal` is 0.6 "Streeterville". Neither the file format
47 specification, nor the `Test.Falderal` API, should be expected to be stable
48 through the 0.x series.
4849
4950 Currently supported features of the framework are:
5051
5859 and collecting the results from it. This sequence of steps is done
5960 automatically with the `falderal test` command.
6061 * Producing readable failure reports. Each test or group of test may be
61 preceded by descriptive text, and this will be displayed above every failing
62 test, along with the expected and actual output.
63 * Testing text-processing functionalities. A test specifies textual input to
64 the function, and may expect a particular textual output, or that a
62 preceded by descriptive text, and this will be displayed above every
63 failing test, along with the expected and actual output.
64 * Testing text-processing functionalities. A test specifies textual input
65 to the function, and may expect a particular textual output, or that a
6566 particular error was encountered. Functionalities are abstract: each
6667 functionality defined in a Falderal file can be implemented in multiple
6768 ways. Thus the same tests can be run multiple times, once for each
7576 History
7677 -------
7778
78 Version 0.6 "Streeterville" (unreleased, currently under development):
79 Version 0.6 "Streeterville" (current released version):
7980
8081 * Variables may be included in the specification of a shell command
8182 implementation; these will be expanded before generating the results
121122 first file would be in effect at the start of the second file.
122123 Files are now loaded and processed seperately.
123124
124 Version 0.5 "The Loop" (current released version):
125 Version 0.5 "The Loop":
125126
126127 * The command-line format of `falderal` has changed, for the better.
127128 The `test` subcommand no longer requires that the failure reporting