From c5d06e7ce098de520d99fdd409295dc25e526122 Mon Sep 17 00:00:00 2001 From: Daniel Kmak <4950658+Kuzirashi@users.noreply.github.com> Date: Tue, 9 Jan 2024 18:03:52 +0100 Subject: [PATCH] add quickstart instruction --- README.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index a76b33e..a1eebb1 100644 --- a/README.md +++ b/README.md @@ -11,32 +11,41 @@ These are the potential advantages of using this repository instead of official I still recommend to consult [official repository of LayerZero](https://github.com/LayerZero-Labs/LayerZero-v2) whenever you need to bring more advanced functionality such as composability, nested calls etc. Examples of such aren't part of this repository as of now. -## Usage - -### Preparation +## Quickstart ``` -cp .env.example .env +git clone https://github.com/Kuzirashi/layerzero-starter-kit.git +cd layerzero-starter-kit +forge install ``` -Fill `TEST_DEPLOYER_KEY` and `TEST_OWNER_ADDRESS` before running deployment script. +*Note: If you don't have Foundry installed yet please follow [installation guide](https://book.getfoundry.sh/getting-started/installation).* + +## Usage ### Build ```shell -$ forge build +forge build ``` ### Test ```shell -$ forge test +forge test ``` *Note: if you want to execute single test file you can add a flag, eg.: `--match-path ./test/CounterUpgradeability.t.sol`.* ### Deploy +Preparation: +``` +cp .env.example .env +``` + +Fill `TEST_DEPLOYER_KEY` and `TEST_OWNER_ADDRESS` before running deployment script. + Dry run: ```shell