@@ -1,8 +1,15 @@
11Tests
22=====
33
4−This directory contains the tests for the Text library. To run these
5−tests, you will need the test data from one of the following
4+This directory contains the tests for the Text library.
5+
6+There are two categories of tests: functional tests (including QuickCheck
7+properties) and benchmarks.
8+
9+Prerequisites
10+-------------
11+
12+To run these tests, you will need the test data from one of the following
613locations:
714
815* Mercurial master repository:
@@ -11,12 +18,10 @@ locations:
1118* Git mirror repository:
1219 [github.com/bos/text-test-data](https://github.com/bos/text-test-data)
1320
14−You should clone that repository to the same directory as this `README`
15−file, then run `make` to uncompress the test files. Many tests will
16−fail if the test files are missing.
17−
18−There are two categories of tests: functional tests (including QuickCheck
19−properties), and benchmarks.
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
23+text-test-data` to uncompress the test files. Many tests will fail if the
24+test files are missing.
2025
2126Functional tests
2227----------------
@@ -43,19 +48,19 @@ Benchmarks
4348The benchmarks are located in the `benchmarks` subdirectory. An overview of
4449what's in that directory:
4550
46− python Python implementations of some benchmarks
47− ruby Ruby implementations of some benchmarks
48− src Source files of the haskell benchmarks
49− benchmarks.cabal Cabal file which compiles all benchmarks
50− Makefile Has targets for common tasks
51+ python Python implementations of some benchmarks
52+ ruby Ruby implementations of some benchmarks
53+ src Source files of the haskell benchmarks
54+ text-benchmarks.cabal Cabal file which compiles all benchmarks
55+ Makefile Has targets for common tasks
5156
5257To compile the benchmarks, navigate to the `benchmarks` subdirectory and run
5358`cabal configure && cabal build`. Then, you can run the benchmarks using:
5459
5560 ./dist/build/benchmarks/benchmarks
5661
57−However, since there quite a lot of benchmarks, you usually don't want to run
58−them all. Instead, use the `-l` flag to get a list of benchmarks:
62+However, since there's quite a lot of benchmarks, you usually don't want to
63+run them all. Instead, use the `-l` flag to get a list of benchmarks:
5964
6065 ./dist/build/benchmarks/benchmarks
6166