Skip to content

Commit

Permalink
📝 README
Browse files Browse the repository at this point in the history
  • Loading branch information
clabby committed Sep 13, 2023
1 parent 4aed379 commit cd3ce82
Showing 1 changed file with 9 additions and 34 deletions.
43 changes: 9 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,14 @@
<img align="right" width="150" height="150" top="100" src="./assets/logo.png">

# `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 [email protected]:clabby/boilerplate-rs.git
```
2. Run the binary
```
cargo r --bin boilerplate-rs
```
[cannon]: https://github.com/ethereum-optimism/optimism/tree/develop/cannon

0 comments on commit cd3ce82

Please sign in to comment.