Commit rel_0_8 - Falderal - git @ Cat's Eye Technologies

Final doc tweaks for release of version 0.8. Cat's Eye Technologies 7 years ago

2 changed file(s) with 10 addition(s) and 4 deletion(s). Raw diff Collapse all Expand all

-2

HISTORY.markdown less more

0	0	History
1	1	=======
2	2
3		Version 0.8-pre "Ukranian Village" (current development version):
	3	Version 0.8 "Ukranian Village" (current released version):
4	4
5	5	* The reference implementation is now `py-falderal`.
	6	* Blocks must now be indented four spaces. That Falderal test documents
	7	will be embedded in Markdown is generally assumed (although not strictly
	8	required) and they generally have the file extension `.markdown` so that
	9	other software (e.g. Bitbucket and Github) knows how to pretty-display
	10	them.
6	11	* Various documentation which was on Bitbucket (wiki, issues) and Github
7	12	(py-falderal issues) have been moved into Markdown documents in the
8	13	distribution, which have themselves been re-organized.

17	22	it just before loading a "tests" Falderal file which specified the
18	23	functionalities being tested, but not their implementations.
19	24
20		Version 0.7 "Ogden Avenue" (current released version):
	25	Version 0.7 "Ogden Avenue" (previous released version):
21	26
22	27	* **Note that this is the final version of Falderal where `Test.Falderal`
23	28	is the reference implementation.** In subsequent versions,

-2

README.markdown less more

0	0	Falderal
1	1	========
2	2
3		Version 0.8-pre "Ukranian Village"
	3	Version 0.8 "Ukranian Village"
4	4
5	5	This is the reference distribution of Falderal, a file format for literate
6	6	test suites. Falderal is particularly suited for:

19	19	the language. That document probably includes examples. Those examples are
20	20	probably intended to produce some kind of output. That output is probably
21	21	expected to be a certain, predicted thing, and if it's not that thing, the
22		implementation is probably considered incorrect
	22	implementation is probably considered incorrect.
23	23
24	24	So why not write those examples in a format that can be tested?
25	25

102	102	sources in `src/falderal`. You don't need to install it; just add
103	103	the `bin` directory of this distribution to your `$PATH`. This
104	104	implementation is (somewhat) documented in `doc/py-falderal.markdown`.
	105	* `src` — source code for py-falderal.
105	106	* `impl/Test.Falderal` — a (lagging, and not conformant) implementation of
106	107	Falderal in Haskell.
107	108	* `tests` — a set of tests for Falderal itself. (Note that these are not