Merge pull request #107 from ethereum/docs-vmtester

docs: Add basic information about evmc-vmtester
This commit is contained in:
Paweł Bylica 2018-08-28 22:38:28 +02:00 committed by GitHub
commit a503fcfb4c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 22 additions and 2 deletions

View File

@ -6,8 +6,10 @@
Use also "evmc_create" function name for loading EVMC DLLs.
- Fix: [[#92](https://github.com/ethereum/evmc/pull/92)]
The evmc.h header compatibility with C++98 fixed.
- Improved: [[#97](https://github.com/ethereum/evmc/pull/97)]
Documentation improvements.
- Fix: [[#93](https://github.com/ethereum/evmc/pull/93)], [[#103](https://github.com/ethereum/evmc/pull/103)]
Compilation and build configuration fixes.
- Improved: [[#97](https://github.com/ethereum/evmc/pull/97)], [[#107](https://github.com/ethereum/evmc/pull/107)]
Documentation improvements, including documentation for the VM Tester.
## [5.1.0] - 2018-08-23

View File

@ -16,6 +16,8 @@ to access Ethereum environment and state.
a collection of utility functions for easier integration with EVMC.
- [EVM Instructions](@ref instructions)
the library with collection of metrics for EVM1 instruction set.
- [EMVC VM Tester](@ref vmtester)
the EVMC-compatibility testing tool for VM implementations.
[eWASM]: https://github.com/ewasm/design

16
docs/VM_Tester.md Normal file
View File

@ -0,0 +1,16 @@
# EVMC VM Tester {#vmtester}
The EVMC project contains a EVMC-compatibility testing tool for VM implementations.
The tool is called `evmc-vmtester` and to include it in the EVMC build
add `-DEVMC_TESTING=ON` CMake option to the project configuration step.
Usage is simple as
```sh
evmc-vmtester [vm]
```
where `[vm]` is a path to a shared library with VM implementation.
For more information check `evmc-vmtester --help`.