feat: Brush up repo for publishing

README.md

@@ -1,3 +1,25 @@
-# zksync-era-vm2
+# High-Performance ZKsync Era VM
 
-A high-performance rewrite of the zksync-era VM.
+A high-performance rewrite of the out-of-circuit VM for ZKsync Era.
+
+## Overview
+
+This repository contains the following crates:
+
+- [`zksync_vm2_interface`](crates/vm2-interface): stable VM interface for tracers
+- [`zksync_vm2`](crates/vm2): VM implementation itself
+- [`zksync_vm2_afl_fuzz`](tests/afl-fuzz): [AFL](https://crates.io/crates/afl)-based fuzzing for the VM.
+
+## Policies
+
+- [Security policy](SECURITY.md)
+- [Contribution policy](CONTRIBUTING.md)
+
+## License
+
+ZKsync Era VM is distributed under the terms of either
+
+- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT license ([LICENSE-MIT](LICENSE-MIT) or <https://opensource.org/blog/license/mit/>)
+
+at your option.

crates/vm2-interface/Cargo.toml

@@ -1,5 +1,7 @@
 [package]
 name = "zksync_vm2_interface"
+description = "Stable interface for ZKsync VM tracers"
+readme = "README.md"
 version.workspace = true
 edition.workspace = true
 authors.workspace = true

crates/vm2-interface/LICENSE-APACHE

@@ -0,0 +1 @@
+../../LICENSE-APACHE

crates/vm2-interface/LICENSE-MIT

@@ -0,0 +1 @@
+../../LICENSE-MIT

crates/vm2-interface/README.md

@@ -0,0 +1,12 @@
+# Stable Interface for ZKsync Era VM
+
+This library provides a stable interface for the EraVM. It defines an interface for tracers that will never change but may be extended.
+
+## License
+
+ZKsync Era VM is distributed under the terms of either
+
+- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT license ([LICENSE-MIT](LICENSE-MIT) or <https://opensource.org/blog/license/mit/>)
+
+at your option.

crates/vm2-interface/src/lib.rs

@@ -6,7 +6,7 @@
 //! not necessary. In fact, tracers should depend on the oldest version that has the required
 //! features.
 //!
-//! A struct implementing [Tracer] may read and mutate the VM's state via [StateInterface]
+//! A struct implementing [`Tracer`] may read and mutate the VM's state via [`StateInterface`]
 //! when particular opcodes are executed.
 //!
 //! ## Why is extreme backwards compatibility required here?
@@ -23,9 +23,9 @@
 //! version that you publish and import it from the previous version instead.
 //!
 //! This is how you would add a new method to StateInterface and a new opcode.
+//!
 //! ```
-//! # use eravm_stable_interface as eravm_stable_interface_v1;
-//! use eravm_stable_interface_v1::{StateInterface as StateInterfaceV1, Tracer as TracerV1, opcodes::NearCall};
+//! use zksync_vm2_interface::{StateInterface as StateInterfaceV1, Tracer as TracerV1, opcodes::NearCall};
 //!
 //! trait StateInterface: StateInterfaceV1 {
 //!     fn get_some_new_field(&self) -> u32;

crates/vm2/Cargo.toml

@@ -1,5 +1,7 @@
 [package]
 name = "zksync_vm2"
+description = "High-performance rewrite of the out-of-circuit VM for ZKsync Era"
+readme = "README.md"
 version.workspace = true
 edition.workspace = true
 authors.workspace = true

crates/vm2/LICENSE-APACHE

@@ -0,0 +1 @@
+../../LICENSE-APACHE

crates/vm2/LICENSE-MIT

@@ -0,0 +1 @@
+../../LICENSE-MIT

crates/vm2/README.md

@@ -0,0 +1,12 @@
+# High-Performance ZKsync Era VM
+
+A high-performance rewrite of the out-of-circuit VM for ZKsync Era.
+
+## License
+
+ZKsync Era VM is distributed under the terms of either
+
+- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT license ([LICENSE-MIT](LICENSE-MIT) or <https://opensource.org/blog/license/mit/>)
+
+at your option.

tests/afl-fuzz/README.md

@@ -5,9 +5,9 @@ Finds divergences and instructions that put vm2 in an invalid state.
 
 Setup: `cargo install cargo-afl`
 
-Use `sh fuzz.sh` (or customize the command to your liking) to start fuzzing.
+Use `sh fuzz.sh` (or customize the command to your liking) to start fuzzing.
 `show_crash.sh` can be used to quickly run one of the found crashes and display all the necessary information
 for fixing it.
 
 The size of the search space is relatively small due to tricks explained in the single_instruction_test module.
-`cargo run --bin check_input_size` prints out an estimate of the amount of information in the state in bytes.
+`cargo run --bin check_input_size` prints out an estimate of the amount of information in the state in bytes.