-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
9 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |