From dad39b922e8f7eb2b09845608795c3c9c48da755 Mon Sep 17 00:00:00 2001 From: glihm Date: Mon, 18 Dec 2023 14:08:42 -0600 Subject: [PATCH] docs: edit README for contracts --- examples/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/examples/README.md b/examples/README.md index 5188c60..448cc17 100644 --- a/examples/README.md +++ b/examples/README.md @@ -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" ```