diff --git a/Readme.md b/Readme.md index 13ee284..64803cc 100644 --- a/Readme.md +++ b/Readme.md @@ -25,6 +25,29 @@ the library. `make dist` will create a tarball (with "configure" inside) with the sources. +Testing +------- + +After any change to the detection routines or match tables, it's always +a good idea to run `make test`. If some test fails, and you're confident +that the test is wrong and needs fixing, run `make fix-tests`. + +You can also add a new test (which is basically a file containing +the raw CPUID data and the expected decoded items) by using +`tests/create_test.py`. The workflow there is as follows: + +1. Run "cpuid_tool" with no arguments. It will tell you that it + has written a pair of files, raw.txt and report.txt. Ensure + that report.txt contains meaningful data. +2. Run "tests/create_test.py raw.txt report.txt > «my-cpu».test" +3. Use a proper descriptive name for the test (look into tests/amd + and tests/intel to get an idea) and copy your test file to an + appropriate place within the tests directory hierarchy. + +For non-developers, who still want to contribute tests for the project, +use [this page](http://libcpuid.sourceforge.net/bugreport.php) to report +misdetections or new CPUs that libcpuid doesn't handle well yet. + Users -----