From cd3ce82b531576a4dff8cd8adb42bb9bda0aeb34 Mon Sep 17 00:00:00 2001 From: clabby Date: Tue, 12 Sep 2023 23:10:32 -0400 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 43 +++++++++---------------------------------- 1 file changed, 9 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index c321202..de0f77b 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,14 @@ -# `boilerplate-rs` • [![ci](https://github.com/clabby/boilerplate-rs/actions/workflows/ci.yaml/badge.svg?label=ci)](https://github.com/clabby/boilerplate-rs/actions/workflows/ci.yaml) ![license](https://img.shields.io/badge/License-MIT-green.svg?label=license) +# `cannon-rs` • [![ci](https://github.com/clabby/cannon-rs/actions/workflows/ci.yaml/badge.svg?label=ci)](https://github.com/clabby/cannon-rs/actions/workflows/ci.yaml) ![license](https://img.shields.io/badge/License-MIT-green.svg?label=license) -A dead simple boilerplate for Rust projects. +`cannon-rs` is an alternative implementation of [Cannon][cannon] in Rust. -**Project Structure** -``` -├── assets -│ └── logo.png -├── bin -│ ├── Cargo.toml -│ └── src -│ └── boilerplate.rs -├── Cargo.lock -├── Cargo.toml -├── crates -│ └── example -│ ├── Cargo.toml -│ └── src -│ └── lib.rs -├── LICENSE.md -└── README.md -``` +* It's Rust code +* ...that was originally Go code +* ...that runs an EVM +* ...emulating a MIPS machine +* ...running compiled Go code +* ...that runs an EVM -**Pre-installed crates** -- [clap](https://crates.io/crates/clap) -- [tracing](https://crates.io/crates/tracing) -- [anyhow](https://crates.io/crates/anyhow) - -**Getting Started** -1. Clone the repo -``` -git clone git@github.com:clabby/boilerplate-rs.git -``` -2. Run the binary -``` -cargo r --bin boilerplate-rs -``` +[cannon]: https://github.com/ethereum-optimism/optimism/tree/develop/cannon