From 401de3f4d785a0f1a26ad32bbf65b68c9de1918f Mon Sep 17 00:00:00 2001 From: Jennifer Date: Thu, 10 Oct 2024 15:12:55 +0100 Subject: [PATCH] Update README.md (#9) Add context on what chapters are, formatting --- README.md | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 834be96..98ff2eb 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,23 @@ # Odyssey Examples -## Overview +This repository provides a step-by-step walk through for builders interested in the developer-preview features available on [Odyssey](https://www.ithaca.xyz/updates/introducing-ithaca), a L2 built for developers to innovate. We are rolling out each Chapter with new features for you to build on. -This repository provides a step-by-step walk through for builders interested in the developer-preview features available on [Odyssey](https://www.ithaca.xyz/updates/introducing-ithaca). Each chapter provides examples of new features added. - -## Chapter 1 -- [Simple Example for EIP-7702](./chapter1/simple-7702/): Basic example to showcase how EIP-7702 transactions work -- [Delegate Account to p256 key](./chapter1/delegate-p256/): Step-by-step walk-through of how EIP-7702+EIP-7212 provide the ability to sign a message with a P256 key -- [BLS Multisig](./chapter1/bls-multisig/): Examples in Python and Rust to showcase Multisig based on BLS signatures verified through precompiles from EIP-2537 +### Chapter 1 +- [Simple Example for EIP-7702](./chapter1/simple-7702/): Showcases how EIP-7702 transactions work +- [Delegate an account to a p256 key](./chapter1/delegate-p256/): Describes how EIP-7702+EIP-7212 provide the ability to sign a message with a P256 key +- [BLS Multisig](./chapter1/bls-multisig/): In-depth walk-through how to implement a Multisig based on BLS signatures verified through precompiles from EIP-2537 - [EOF](./chapter1/eof/): Instructions on how to deploy and inspect contracts in the new EOF format -## Build & Run +### Build & Test -Use foundry to build and run smart contracts in the repo +Use [foundry](https://github.com/foundry-rs/foundry) to build and run smart contracts in the repository: ```bash # Make sure foundry is up to date foundryup # Compile contracts and run tests in chapter 1 -cd chapter1 +cd chapter1/ forge build forge test -```` \ No newline at end of file +````