diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 14 |
1 files changed, 2 insertions, 12 deletions
| @@ -4,23 +4,13 @@ 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 | ## Building and running tests | 7 | ## Running tests |
| 8 | |||
| 9 | Tests: | ||
| 10 | 8 | ||
| 11 | ``` | 9 | ``` |
| 10 | $ ./configure.sh # Run 'TYPE=AVX2 ./configure.sh' to use AVX2 instead | ||
| 12 | $ make test | 11 | $ make test |
| 13 | ``` | 12 | ``` |
| 14 | 13 | ||
| 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 | |||
| 24 | ## TODO: | 14 | ## TODO: |
| 25 | 15 | ||
| 26 | ### Cleanup / refactor | 16 | ### Cleanup / refactor |
