@@ -1,8 +1,15 @@
4−This directory contains the tests for the Text library. To run these
4+This directory contains the tests for the Text library.
6+There are two categories of tests: functional tests (including QuickCheck
7+properties) and benchmarks.
5−tests, you will need the test data from one of the following
12+To run these tests, you will need the test data from one of the following
8* Mercurial master repository:
15* Mercurial master repository:
@@ -11,12 +18,10 @@ locations:
11* Git mirror repository:
18* Git mirror repository:
12 [github.com/bos/text-test-data](https://github.com/bos/text-test-data)
19 [github.com/bos/text-test-data](https://github.com/bos/text-test-data)
14−You should clone that repository to the same directory as this `README`
21+You should clone that repository to the same directory as this `README` file
22+(your clone must be named `text-test-data` locally), then run `make -C
15−file, then run `make` to uncompress the test files. Many tests will
23+text-test-data` to uncompress the test files. Many tests will fail if the
16−fail if the test files are missing.
24+test files are missing.
18−There are two categories of tests: functional tests (including QuickCheck
19−properties), and benchmarks.
21Functional tests
26Functional tests
22----------------
27----------------
@@ -43,19 +48,19 @@ Benchmarks
43The benchmarks are located in the `benchmarks` subdirectory. An overview of
48The benchmarks are located in the `benchmarks` subdirectory. An overview of
44what's in that directory:
49what's in that directory:
46− python Python implementations of some benchmarks
51+ python Python implementations of some benchmarks
47− ruby Ruby implementations of some benchmarks
52+ ruby Ruby implementations of some benchmarks
48− src Source files of the haskell benchmarks
53+ src Source files of the haskell benchmarks
49− benchmarks.cabal Cabal file which compiles all benchmarks
54+ text-benchmarks.cabal Cabal file which compiles all benchmarks
50− Makefile Has targets for common tasks
55+ Makefile Has targets for common tasks
52To compile the benchmarks, navigate to the `benchmarks` subdirectory and run
57To compile the benchmarks, navigate to the `benchmarks` subdirectory and run
53`cabal configure && cabal build`. Then, you can run the benchmarks using:
58`cabal configure && cabal build`. Then, you can run the benchmarks using:
55 ./dist/build/benchmarks/benchmarks
60 ./dist/build/benchmarks/benchmarks
57−However, since there quite a lot of benchmarks, you usually don't want to run
62+However, since there's quite a lot of benchmarks, you usually don't want to
58−them all. Instead, use the `-l` flag to get a list of benchmarks:
63+run them all. Instead, use the `-l` flag to get a list of benchmarks:
60 ./dist/build/benchmarks/benchmarks
65 ./dist/build/benchmarks/benchmarks