Skip to content

Commit d81ffe0

Browse files
docs: update CONTRIBUTING.md
1 parent b1b633c commit d81ffe0

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ You can also add a new test (which is basically a file containing
1010
the raw CPUID data and the expected decoded items) by using
1111
`tests/create_test.py`. The workflow there is as follows:
1212

13-
1. Run "cpuid_tool" with no arguments. It will tell you that it
14-
has written a pair of files, raw.txt and report.txt. Ensure
15-
that report.txt contains meaningful data.
16-
2. Run "tests/create_test.py raw.txt report.txt > «my-cpu».test"
17-
3. Use a proper descriptive name for the test (look into tests/amd
18-
and tests/intel to get an idea) and copy your test file to an
19-
appropriate place within the tests directory hierarchy.
13+
1. Run `cpuid_tool` with no arguments. It will tell you that it
14+
has written a pair of files, `raw.txt` and `report.txt`. Ensure
15+
that `report.txt` contains meaningful data.
16+
2. Run `./tests/create_test.py raw.txt report.txt > my-cpu.test`
17+
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)
18+
(look into [`tests/amd`](tests/amd) and [`tests/intel`](tests/intel) to get an idea),
19+
and copy your test file to an appropriate place within the tests directory hierarchy.
2020

2121
AIDA64 CPUID dumps (mostly found on [InstLatx64](http://instlatx64.atw.hu/)) are also supported.
22-
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.
22+
To create a new test from InstLatx64, you can use the [`create_test_from_instlatx64.sh`](utils/create_test_from_instlatx64.sh) script.
2323

2424
For non-developers, who still want to contribute tests for the project,
2525
use [this page](https://github.com/anrieff/libcpuid/issues/new) to report

0 commit comments

Comments
 (0)