Skip to content

Commit

Permalink
♻️ Clean docs
Browse files Browse the repository at this point in the history
  • Loading branch information
clabby committed Sep 23, 2023
1 parent a2803e6 commit b5baef6
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 9 deletions.
13 changes: 4 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
<a href="#overview">Overview</a> •
<a href="#credits">Credits</a> •
<a href="#benchmarks">Benchmarks</a> •
<a href="#usage">Usage</a> •
<a href="#contributing">Contributing</a> •
<a href="#documentation">Documentation</a> •
<a href="#docker">Docker</a>
Expand Down Expand Up @@ -54,23 +53,19 @@ credits for the original idea and reference implementation of this concept go to

## Benchmarks

The below benchmarks are ran on a 2021 Macbook Pro with an M1 Max and 32 GB of unified memory and taken
on commit [`83e4c56`](https://github.com/anton-rs/cannon-rs/tree/83e4c5643193aac19046ef29b5018137b5eb05f2).

### `cannon-mipsevm` benchmarks

The below benchmark was ran on a 2021 Macbook Pro with an M1 Max and 32 GB of unified memory
on commit [`83e4c56`](https://github.com/anton-rs/cannon-rs/tree/83e4c5643193aac19046ef29b5018137b5eb05f2).

| Benchmark Name | `cannon` mean (Reference) | `cannon-rs` mean |
|----------------------------|---------------------------|---------------------|
| Memory Merkle Root (25MB) | 736.94 ms | 328.67 µs (-99%) |
| Memory Merkle Root (50MB) | 1.54s | 548.85 ms (-63.36%) |
| Memory Merkle Root (100MB) | 3.34s | 1.16s (-65.29%) |
| Memory Merkle Root (200MB) | 6.30s | 2.14s (-66.01%) |

*todo*

## Usage

*todo*
*todo - execution benchmarks*

## Contributing

Expand Down
6 changes: 6 additions & 0 deletions bin/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# `cannon`

> **Note**
> Not started yet; Blocked by preimage oracle ABI bindings.
This crate contains the implementation of the Cannon binary for `cannon-rs`.

0 comments on commit b5baef6

Please sign in to comment.