Home

Awesome

The Ethereum Virtual Machine

This repository is intended to contain a full in depth explanation of the Ethereum Virtual Machine and its execution environment for developers seeking lower level control than what is given in high level languages.

This book is a work in progress and contributions in line with the contributing policy are welcomed!

Local Usage

To build this book locally, you will need mdbook.

Clone the repository:

git clone https://github.com/JoshuaTrujillo15/the-ethereum-virtual-machine/

Install mdbook - Rust crate for converting markdown to ebook :

cargo install mdbook

Install rust on Windows (WSL)

 curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Install rust on Linux/MacOS

curl https://sh.rustup.rs -sSf | sh -s -- --help

Enter this directory:

cd the-ethereum-virtual-machine

Start an mdbook server and automatically open the book in a browser.

mdbook serve --open

MDBOOK Addons

This mdbook has two addons with the following functions. They can installed with the following command:

cargo install mdbook-mermaid mdbook-admonish

TODO Items: