From bf951688b08126d526eac45234da30f49f21b1bd Mon Sep 17 00:00:00 2001 From: protolambda Date: Thu, 28 Mar 2019 00:43:56 +0800 Subject: [PATCH] update pyspec readme --- test_libs/pyspec/README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/test_libs/pyspec/README.md b/test_libs/pyspec/README.md index 2747ad8f3..25ee737f7 100644 --- a/test_libs/pyspec/README.md +++ b/test_libs/pyspec/README.md @@ -1,3 +1,17 @@ # ETH 2.0 PySpec -The py \ No newline at end of file +The Python executable spec is built from the ETH 2.0 specification, + complemented with the necessary helper functions for hashing, BLS, and more. + +With this executable spec, + test-generators can easily create test-vectors for client implementations, + and the spec itself can be verified to be consistent and coherent, through sanity tests implemented with pytest. + +Contributions are welcome, but consider implementing your idea as part of the spec itself first. +The pyspec is not a replacement. +If you see opportunity to include any of the `utils/` code in the spec, + please submit an issue or PR. + +## License + +Same as the spec itself, see LICENSE file in spec repository root.