mirror/libcpuid
1
0
Fork 0
mirror of https://github.com/anrieff/libcpuid synced 2025-07-02 14:04:15 +00:00
Code Issues Releases Wiki Activity

docs: update CONTRIBUTING.md

Browse source
This commit is contained in:
The Tumultuous Unicorn Of Darkness 2025-05-04 11:27:53 +02:00
parent b1b633caa5
commit d81ffe0bab
No known key found for this signature in database
GPG key ID: 1E55EE2EFF18BC1A
1 changed files with 8 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

16
CONTRIBUTING.md
View file

@ -10,16 +10,16 @@ You can also add a new test (which is basically a file containing
the raw CPUID data and the expected decoded items) by using the raw CPUID data and the expected decoded items) by using
`tests/create_test.py`. The workflow there is as follows: `tests/create_test.py`. The workflow there is as follows:
1. Run "cpuid_tool" with no arguments. It will tell you that it 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 has written a pair of files, `raw.txt` and `report.txt`. Ensure
that report.txt contains meaningful data. that `report.txt` contains meaningful data.
2. Run "tests/create_test.py raw.txt report.txt > «my-cpu».test" 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 3. Use a proper descriptive name for the test, like the CPU brand name in [*kebab-case*](https://developer.mozilla.org/en-US/docs/Glossary/Kebab_case)
and tests/intel to get an idea) and copy your test file to an (look into [`tests/amd`](tests/amd) and [`tests/intel`](tests/intel) to get an idea),
appropriate place within the tests directory hierarchy. and copy your test file to an appropriate place within the tests directory hierarchy.
AIDA64 CPUID dumps (mostly found on [InstLatx64](http://instlatx64.atw.hu/)) are also supported. AIDA64 CPUID dumps (mostly found on [InstLatx64](http://instlatx64.atw.hu/)) are also supported.
To create a new test based on a AIDA64 CPUID dump, you can use the [`create_test_from_instlatx64.sh`](utils/create_test_from_instlatx64.sh) script. To create a new test from InstLatx64, you can use the [`create_test_from_instlatx64.sh`](utils/create_test_from_instlatx64.sh) script.
For non-developers, who still want to contribute tests for the project, For non-developers, who still want to contribute tests for the project,
use [this page](https://github.com/anrieff/libcpuid/issues/new) to report use [this page](https://github.com/anrieff/libcpuid/issues/new) to report