Skip to content

Commit de55548

Browse files
authored
Update README (#645)
1 parent aed9d04 commit de55548

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ specification and the JSON schema [specification][json-schema] to get started.
2121

2222
### Building
2323

24-
The specification is split into multiple files to improve readability. The
24+
The specification is split into multiple files to improve readability. The
2525
spec can be compiled into a single document as follows:
2626

2727
```console
@@ -36,7 +36,7 @@ will have all schema `#ref`s resolved.
3636
#### Testing
3737

3838
There are several mechanisms for testing specification contributions and client
39-
conformance.
39+
conformance.
4040

4141
First is the [OpenRPC validator][validator]. It performs some basic syntactic
4242
checks on the generated specification.
@@ -56,6 +56,13 @@ $ speccheck -v
5656
all passing.
5757
```
5858

59+
If you get an error that says: `speccheck: command not found`,
60+
make sure that the go binary is in your $PATH:
61+
62+
```console
63+
$ export PATH=$HOME/go/bin:$PATH
64+
```
65+
5966
The spell checker ensures the specification is free of spelling errors.
6067

6168
```console
@@ -64,6 +71,10 @@ $ pyspelling -c spellcheck.yaml
6471
Spelling check passed :)
6572
```
6673

74+
pyspelling is a wrapper around either [Aspell](http://aspell.net/) or
75+
[Hunspell](https://hunspell.github.io/). You'll need to install
76+
one of those before running `pyspelling`.
77+
6778
Finally, the test cases in the `tests/` directory may be run against individual
6879
execution client using the [`hive`] simulator [`rpc-compat`][rpc-compat].
6980
Please see the documentation in the aforementioned repositories for more
@@ -102,7 +113,7 @@ This repository is licensed under [CC0](LICENSE).
102113
[graphql-schema]: http://graphql-schema.ethdevops.io/?url=https://raw.githubusercontent.com/ethereum/execution-apis/main/graphql.json
103114
[eip-1767]: https://eips.ethereum.org/EIPS/eip-1767
104115
[making-changes]: docs/making-changes.md
105-
[json-schema]: https://json-schema.org
116+
[json-schema]: https://json-schema.org
106117
[hive]: https://github.com/ethereum/hive
107118
[rpc-compat]: https://github.com/ethereum/hive/tree/master/simulators/ethereum/rpc-compat
108119
[test-gen]: tests/README.md

0 commit comments

Comments
 (0)