Skip to content

Commit

Permalink
docs: edit README for contracts
Browse files Browse the repository at this point in the history
  • Loading branch information
glihm committed Dec 18, 2023
1 parent 1d01e30 commit dad39b9
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,30 @@
# Examples

## Usage

To run the example, please consider the following:

1. Spin up a katana instance ([install here](curl -L https://install.dojoengine.org | bash)):

```
dojoup -v
katana
```

2. Generates the artifacts to have the abi being extracted:

```
make generate_artifacts
```

3. Setup (declare and deploy) the contract of your choice:

```
make setup_simple_get_set
```

4. Run the example

```
cargo run --example simple_get_set --features="abigen-rs"
```

0 comments on commit dad39b9

Please sign in to comment.