Skip to content

Update README #645

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lightclient merged 1 commit into from
May 14, 2025
Merged

Update README #645

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ specification and the JSON schema [specification][json-schema] to get started.

### Building

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

```console
Expand All @@ -36,7 +36,7 @@ will have all schema `#ref`s resolved.
#### Testing

There are several mechanisms for testing specification contributions and client
conformance.
conformance.

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

If you get an error that says: `speccheck: command not found`,
make sure that the go binary is in your $PATH:

```console
$ export PATH=$HOME/go/bin:$PATH
```

The spell checker ensures the specification is free of spelling errors.

```console
Expand All @@ -64,6 +71,10 @@ $ pyspelling -c spellcheck.yaml
Spelling check passed :)
```

pyspelling is a wrapper around either [Aspell](http://aspell.net/) or
[Hunspell](https://hunspell.github.io/). You'll need to install
one of those before running `pyspelling`.

Finally, the test cases in the `tests/` directory may be run against individual
execution client using the [`hive`] simulator [`rpc-compat`][rpc-compat].
Please see the documentation in the aforementioned repositories for more
Expand Down Expand Up @@ -102,7 +113,7 @@ This repository is licensed under [CC0](LICENSE).
[graphql-schema]: http://graphql-schema.ethdevops.io/?url=https://raw.githubusercontent.com/ethereum/execution-apis/main/graphql.json
[eip-1767]: https://eips.ethereum.org/EIPS/eip-1767
[making-changes]: docs/making-changes.md
[json-schema]: https://json-schema.org
[json-schema]: https://json-schema.org
[hive]: https://github.com/ethereum/hive
[rpc-compat]: https://github.com/ethereum/hive/tree/master/simulators/ethereum/rpc-compat
[test-gen]: tests/README.md