Skip to content

Commit

Permalink
docs(PR): update PR template
Browse files Browse the repository at this point in the history
  • Loading branch information
clearloop committed Dec 2, 2024
1 parent 088964e commit bb39104
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 25 deletions.
26 changes: 25 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,29 @@ Resolves #
### Changes

- [x] step 1
- [ ] step 2
- [ ] ...

<!--
If you are solving a budget issue, please add your wallet address here.
We will use it to send you the bounty once the PR is merged.
Polygon Address: `0x0000000000000000000000000000000000000000`
-->

<!--
NOTES for testing your changes:
```
# Clippy all packages
cargo cc
# Run all tests
cargo tt
# Build all examples
cargo be
# Run tests for examples
cargo te
```
-->
47 changes: 23 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,30 +10,8 @@
[![ci][ci-badge]][ci-link]
[![telegram][telegram-badge]][telegram-group]

Rustic smart contract language that targets the EVM.

```mermaid
flowchart LR
R{{Rust}} --> W(WASM)
W --> Z{Zink Compiler}
Z --> V[(EVM)]
```

- **Safe**: `rustc` monitors your code! After compiling to WASM, `zinkc` precomputes stack
and memory usage to ensure safety in EVM bytecode.

- **High Performance**: Optimizations from `rustc`, `wasm-opt`, and `zinkc` yield small,
high-performance EVM bytecode.

- **Modular**: Upload and download your contract components via `crates.io`.

- **Easy Debugging**: Develop smart contracts just in rust! All of the rust tools are available for your contracts!

Run `cargo install zinkup` to install the toolchain!

## ERC20 Example (In Development)

```rust
//! ERC20 Example (In Development)
#[zink::contract]
pub struct ERC20;

Expand All @@ -53,9 +31,30 @@ impl ERC20 for ERC20 {
}
```

- **Safe**: `rustc` monitors your code!

- **Efficient**: Optimizations from `rustc`, `wasm-opt`, and `zinkc` yield efficient EVM bytecode.

- **Modular**: Upload and download your contract components via `crates.io`.

- **Easy Debugging**: All of the rust tools are available for your contracts!

Run `cargo install zinkup` to install the toolchain! See [book](https://zink-lang.org/) for the handbook.

## Testing & Development

| Command | Description |
| ---------- | ---------------------- |
| `cargo cc` | Clippy all packages |
| `cargo tt` | Run all tests |
| `cargo be` | Build all examples |
| `cargo te` | Run tests for examples |

We're using `cargo-nextest` for testing, the commands above are described in [.cargo/config.toml](.cargo/config.toml).

## Special Thanks

- [MegaETH](https://github.com/MegaETH) for the funding and trust!
- [MegaETH](https://github.com/megaeth-labs) for the funding and trust!
- [revm](https://github.com/bluealloy/revm) for the EVM in rust!

## LICENSE
Expand Down

0 comments on commit bb39104

Please sign in to comment.