diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 14 |
1 files changed, 12 insertions, 2 deletions
| @@ -4,13 +4,23 @@ Work in progress. There is some documentation at the bottom of this page, | |||
| 4 | but do not believe it. Everything is in a state of flux and can change | 4 | but do not believe it. Everything is in a state of flux and can change |
| 5 | without notice. | 5 | without notice. |
| 6 | 6 | ||
| 7 | ## Running tests | 7 | ## Building and running tests |
| 8 | |||
| 9 | Tests: | ||
| 8 | 10 | ||
| 9 | ``` | 11 | ``` |
| 10 | $ ./configure.sh # Run 'TYPE=AVX2 ./configure.sh' to use AVX2 instead | ||
| 11 | $ make test | 12 | $ make test |
| 12 | ``` | 13 | ``` |
| 13 | 14 | ||
| 15 | Benchmarks: | ||
| 16 | |||
| 17 | ``` | ||
| 18 | $ make benchmark | ||
| 19 | ``` | ||
| 20 | |||
| 21 | Prefix each make instruction with `TYPE=AVX2` to try the AVX2 version | ||
| 22 | (e.g. `TYPE=AVX2 make benchmark`). | ||
| 23 | |||
| 14 | ## TODO: | 24 | ## TODO: |
| 15 | 25 | ||
| 16 | ### Cleanup / refactor | 26 | ### Cleanup / refactor |
