Skip to content

Commit f59df50

Browse files
committed
docs: mention docs/ folder
1 parent ad54dd1 commit f59df50

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,16 @@ At the time of writing, the following `testvectors_v1` files are missing schemas
144144

145145
Contribution of schemas for the above vectors would be most welcome.
146146

147+
### Is there additional documentation about test vectors?
148+
149+
Some legacy documentation for [files](doc/files.md), [formats](doc/formats.md)
150+
and [types](doc/types.md) are available, but not necessarily in-sync with the
151+
current test vector state.
152+
153+
In general, prefer referencing the [schema files](schemas) since these are tested
154+
[in CI](https://github.com/cpu/wycheproof/actions/workflows/vectorlint.yml) to
155+
ensure vector file contents match their advertised schema.
156+
147157
### Where is the test harness code?
148158

149159
Historically Wycheproof also included test harnesses (e.g. for Java and

0 commit comments

Comments
 (0)