diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 21 |
1 files changed, 19 insertions, 2 deletions
| @@ -4,13 +4,30 @@ 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 | First run | ||
| 10 | |||
| 11 | ``` | ||
| 12 | $ ./configure.sh | ||
| 13 | ``` | ||
| 14 | |||
| 15 | or `TYPE=AVX2 ./configure.sh` if you want to use AVX2 instructions. | ||
| 16 | |||
| 17 | Then | ||
| 8 | 18 | ||
| 9 | ``` | 19 | ``` |
| 10 | $ ./configure.sh # Run 'TYPE=AVX2 ./configure.sh' to use AVX2 instead | ||
| 11 | $ make test | 20 | $ make test |
| 12 | ``` | 21 | ``` |
| 13 | 22 | ||
| 23 | to run the tests. You can also run | ||
| 24 | |||
| 25 | ``` | ||
| 26 | $ make benchmark | ||
| 27 | ``` | ||
| 28 | |||
| 29 | for benchmarks. | ||
| 30 | |||
| 14 | ## TODO: | 31 | ## TODO: |
| 15 | 32 | ||
| 16 | ### Cleanup / refactor | 33 | ### Cleanup / refactor |
