Skip to content

Commit

Permalink
doc: improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
Yashiru committed Jul 20, 2023
1 parent c62aa6f commit 6ec2bd9
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ The EVM Rust Emulator is a simple in-memory Ethereum Virtual Machine (EVM) emula

![Github action](https://github.com/Yashiru/evm-rs-emulator/workflows/CI/badge.svg)

## Run some bytecode
Put the bytecode to run in `bytecode.bin` file and run the following command.
```bash
cargo run
```

## Disclaimer
This crate is in development and it is at this point only a bytecode interpreter with a full EVM emulation. It require a lib module with all external accessible features to make this crate a real lib crate that can be used as an external crate in other projects.

Expand Down

0 comments on commit 6ec2bd9

Please sign in to comment.